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

Unify naming of Actions, Templates etc. #85

Open
2 tasks
ejcsid opened this issue Dec 11, 2024 · 4 comments · May be fixed by #88
Open
2 tasks

Unify naming of Actions, Templates etc. #85

ejcsid opened this issue Dec 11, 2024 · 4 comments · May be fixed by #88

Comments

@ejcsid
Copy link

ejcsid commented Dec 11, 2024

  • Translations: Some action, workflow or step descriptions are written in english, some in german. We should unify them to use english only.
  • Add metadata by providing descriptions and names : Its possible to add metadata to GitHub actions, workflows and steps by providing the description field e.g. for input properties, workflow descriptions and so on.
    Additionally we should give a readable name property to all steps
@ejcsid ejcsid moved this to Todo in SPS Dec 11, 2024
@ejcsid ejcsid added this to SPS Dec 11, 2024
@simonhir
Copy link
Member

simonhir commented Dec 11, 2024

Currently we have a mixing of kebab case and spaced spelling for workflows and actions. For better readability and consistency we should standardize this. I.e.:

@ejcsid ejcsid changed the title Naming der Actions, Templates etc. vereinheitlichen Unify naming of Actions, Templates etc. Dec 11, 2024
@devtobi
Copy link
Member

devtobi commented Dec 11, 2024

I'd encourage to use readable names because those are also shown in the GitHub actions UI.

The file name in my opinion should be kebab case, but which exact file naming schema for actions, workflows, reusable workflows, workflow templates and so on?

Also we should provide useful descriptions for all actions and workflows.

@ejcsid
Copy link
Author

ejcsid commented Dec 17, 2024

Why not using same style as in Github Actions Samples (see e.g. https://github.com/actions/setup-java/tree/main/.github/workflows):

  • name (Actionname): Readable name (e.g. Maven Release)
  • jobname: minor letters separated with - (e.g. maven-release)
  • ´filename: minor letters separated with -` (e.g. maven-release.yaml)

Also we should provide useful descriptions for all actions and workflows.

👍

@ejcsid ejcsid moved this from Todo to In Progress in SPS Dec 17, 2024
@ejcsid ejcsid moved this from In Progress to Todo in SPS Dec 17, 2024
@hupling
Copy link
Collaborator

hupling commented Dec 19, 2024

Ich habe einmal die beiden geschlossen.

das kann man gleich hier mitmachen

@hupling hupling linked a pull request Dec 19, 2024 that will close this issue
@hupling hupling linked a pull request Dec 19, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Development

Successfully merging a pull request may close this issue.

4 participants