Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Github action #23

Merged
merged 4 commits into from
Sep 27, 2023
Merged

Add Github action #23

merged 4 commits into from
Sep 27, 2023

Conversation

fmauch
Copy link
Contributor

@fmauch fmauch commented Jul 14, 2023

This PR aims at adding a github action that could be included by other repos. At the time of creating this, there is a first working version that is probably not optimal (hence the draft), since I am rather new to the topic of writing custom actions.

You can see an example of this action being used here.

Obviously, the action could be moved to its own repository, as well, but I decided to include it here at least for a first, testable version.


Edit: I've been thinking that from my point of view, this might actually a valid solution that could act as a first version. Whether or not we want to use a more versioned approach or move the action to its own repo is something to decide for the maintainers.

This allows this repo being used as a GH action in other projects.

Signed-off-by: Felix Exner <[email protected]>
@fmauch fmauch marked this pull request as ready for review July 17, 2023 11:11
Copy link
Member

@ct2034 ct2034 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for your contribution, @fmauch. To support this, I have fixed the versioning scheme for the package, which would then also be the version of the action that people could state when they use it, rather than the branch.
But I want to ask you to add a section and brief usage example to the README.md.

Explain how to use this tool inside a github workflow and checked the tick for a github action on the feature list.

Signed-off-by: Felix Exner <[email protected]>
@fmauch
Copy link
Contributor Author

fmauch commented Jul 22, 2023

I've added an action usage section to the main README. It uses the latest version currently being present on the main branch. @ct2034 Do you plan to add tags for each version?

Most actions that I know keep a major version tag running along the latest patch version. So in this case there would be a v1 tag pointing to the same commit as 1.1.5 at the time of writing. If you plan to also do this, we could reference @v1 inside the workflow definition. This is probably less brittle as you otherwise would have to bump the version in the workflow example in the README each time you do a patch release.

@fmauch fmauch requested a review from ct2034 July 22, 2023 06:25
Copy link
Member

@ct2034 ct2034 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again for the contribution. This looks awesome

@ct2034 ct2034 merged commit ac97b5b into boschresearch:main Sep 27, 2023
ct2034 added a commit that referenced this pull request Sep 27, 2023
* Added action.yml

This allows this repo being used as a GH action in other projects.

Signed-off-by: Felix Exner <[email protected]>

* Added README entry about GitHub action

Explain how to use this tool inside a github workflow and checked the tick for a github action on the feature list.

Signed-off-by: Felix Exner <[email protected]>

---------

Signed-off-by: Felix Exner <[email protected]>
Co-authored-by: Christian Henkel <[email protected]>
Signed-off-by: Christian Henkel <[email protected]>
ct2034 added a commit that referenced this pull request Sep 27, 2023
* systems test that actually look at copyright files

Signed-off-by: Christian Henkel <[email protected]>

* support for url in Source

Signed-off-by: Christian Henkel <[email protected]>

* linter

Signed-off-by: Christian Henkel <[email protected]>

* Add Github action (#23)

* Added action.yml

This allows this repo being used as a GH action in other projects.

Signed-off-by: Felix Exner <[email protected]>

* Added README entry about GitHub action

Explain how to use this tool inside a github workflow and checked the tick for a github action on the feature list.

Signed-off-by: Felix Exner <[email protected]>

---------

Signed-off-by: Felix Exner <[email protected]>
Co-authored-by: Christian Henkel <[email protected]>
Signed-off-by: Christian Henkel <[email protected]>

* isort

Signed-off-by: Christian Henkel <[email protected]>

---------

Signed-off-by: Christian Henkel <[email protected]>
Signed-off-by: Felix Exner <[email protected]>
Co-authored-by: Felix Exner (fexner) <[email protected]>
@fmauch fmauch deleted the action branch September 29, 2023 13:05
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants