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

#556: Create tags for Go projects #560

Merged
merged 11 commits into from
Mar 26, 2024
Merged

#556: Create tags for Go projects #560

merged 11 commits into from
Mar 26, 2024

Conversation

kaklakariada
Copy link
Collaborator

Closes #556

.github/workflows/ci-build.yml Outdated Show resolved Hide resolved
Copy link
Collaborator

Choose a reason for hiding this comment

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

Please forgive my finding / proposal: At some day we might need to think of a way to verify workflow files in tests. Either we create a parser and runner on our own or maybe someone else had the same challenge before .... 🤔

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Good point. One option could be to extract the shell scripts and simply run them in integration tests. @redcatbear suggested to skip for now. If we modify the workflow/scripts more often, we can think about adding these tests.

echo "release-url=$release_url" >> "$GITHUB_OUTPUT"

echo "#### Creating Additional Tags" >> "$GITHUB_STEP_SUMMARY"
Copy link
Collaborator

Choose a reason for hiding this comment

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

Maybe a comment or a reference to requirements / design would be nice, here?

E.g.

  • # Go projects need an additional tag prefixed with "v"
  • or [impl->dsn~release-workflow.create-golang-tags~1]

Copy link
Collaborator

Choose a reason for hiding this comment

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

Oh, I see an additional challenge - maybe 2 challenges:

  • file might be generated by PK so the reqs might apply to the template file but should not affect req tracing of a project using PK to generate its workflow files. 🤔 Oh oh ....
  • maybe file is even modified as PK itself has deviates from default?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

The req tracing tag is added to project-keeper/src/main/resources/templates/.github/workflows/release.yml:

# [impl->dsn~release-workflow.create-golang-tags~1]
echo "#### Creating Additional Tags" >> "$GITHUB_STEP_SUMMARY"
...

Regarding your second comment:

  • Workflow files should not affect req tracing in other projects, because usually the .github folder is not scanned for requirements
  • Yes, the file was modified for PK itself. This will be fixed once we can customize the build steps.

doc/requirements/design.md Outdated Show resolved Hide resolved
Copy link

@kaklakariada kaklakariada merged commit 3aa5763 into main Mar 26, 2024
8 checks passed
@kaklakariada kaklakariada deleted the kaklakariada/issue556 branch March 26, 2024 11:41
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.

Add support for releasing Go projects
2 participants