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

Migrate to centralized GitHub workflows #31

Merged
merged 4 commits into from
Dec 31, 2023

Conversation

nicholasmhughes
Copy link
Member

@nicholasmhughes nicholasmhughes commented Dec 29, 2023

What does this PR do?

This PR implements calls to "reusable workflows" housed in the salt-extensions/central-artifacts repository. This should allow us to more easily keep GitHub Actions up-to-date without requiring PRs to be opened for every extension. The proposed workflow YAML can be viewed in the central-artifacts repository, but for posterity the Push/PR and Release pipelines look something like this:

  • Push/PR
    • Automatic Processes (kicked off by push/PR)
      • Run pre-commit checks
      • Run test matrix for Linux, Windows, and macOS
      • Run doc build
  • Tag Creation
    • Manual Processes
      • Create a PR to update the CHANGELOG with towncrier
      • Create a tag at the merged commit above for the release version using semantic versioning (i.e. v1.0.0)
    • Automatic Processes (kicked off by tag creation)
      • Run pre-commit checks
      • Run test matrix for Linux, Windows, and macOS
      • Run doc build
      • Build the package
      • Release the package to Test PyPi (uses the saltext-community account)
      • Create a GitHub Release for the package
      • Release the package to PyPi (uses the saltext-community account)

Commits signed with GPG?

Yes

Please review Salt's Contributing Guide for best practices.

See GitHub's page on GPG signing for more information about signing commits with GPG.

Copy link
Member

@lkubb lkubb left a comment

Choose a reason for hiding this comment

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

Thanks for doing all this work, very happy about more centralization in the salt-extensions org!

Do you have a solution handy for the Vault setup or should I look into it?

Also, the pre-commit workflow is failing, maybe this repo's secrets need to be updated (?).

.github/workflows/test-action.yml Show resolved Hide resolved
@nicholasmhughes
Copy link
Member Author

I probably should've put this in Draft status... but here we are. Pre-commit is failing due to a problem with getting changed files via Action. I think it's because I indiscriminately updated the action version, and there's probably an output format change... Looking into it later today.

@nicholasmhughes
Copy link
Member Author

Ok. All fixed up. Let me know if you think this will work for our needs.

Copy link
Member

@lkubb lkubb left a comment

Choose a reason for hiding this comment

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

Love it, thank you very much! 👍 Now we're just missing readthedocs for salt-extensions, then everything should be neat.

I will make this enhancement an optional part of the copier template as well.

Sorry for taking so long to review btw, somehow missed the update.

Have a happy new year! 🚀

@lkubb lkubb merged commit 7333cbf into salt-extensions:main Dec 31, 2023
20 checks passed
@nicholasmhughes nicholasmhughes deleted the centralize-workflows branch January 1, 2024 19:31
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