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 Actions workflow for tagging releases #6

Merged
merged 2 commits into from
Dec 7, 2024
Merged

Conversation

mauvehed
Copy link
Owner

@mauvehed mauvehed commented Dec 7, 2024

ci(build-version.yml): add GitHub Actions workflow for tagging releases

Create a new GitHub Actions workflow to automate the process of tagging
releases. The workflow triggers on push, pull request, and manual
dispatch events. It checks out the repository, installs dependencies,
generates a build version, and builds the application.

chore(package.json): remove redundant generate-version script from build command

The generate-version script is now handled separately in the GitHub
Actions workflow, making it unnecessary to include it in the local
build command. This change streamlines the build process and ensures
version generation is consistently managed by the CI pipeline.

Summary by Sourcery

Implement a GitHub Actions workflow to automate release tagging and streamline the build process by removing the local 'generate-version' script. Update developer documentation to reflect changes in branch management.

CI:

  • Add a GitHub Actions workflow to automate the process of tagging releases, triggered by push, pull request, and manual dispatch events.

Documentation:

  • Update DEVELOPERS.md to include instructions for switching to and syncing the develop branch with main.

Chores:

  • Remove the redundant 'generate-version' script from the build command in package.json as it is now handled by the CI workflow.

… main

Provide additional guidance for developers on how to switch to the
develop branch and ensure it is up-to-date with the main branch. This
helps maintain consistency and reduces potential merge conflicts by
keeping the develop branch synchronized with the latest changes from
the main branch.
Create a new GitHub Actions workflow to automate the process of tagging
releases. The workflow triggers on push, pull request, and manual
dispatch events. It checks out the repository, installs dependencies,
generates a build version, and builds the application.

chore(package.json): remove redundant generate-version script from build command

The `generate-version` script is now handled separately in the GitHub
Actions workflow, making it unnecessary to include it in the local
build command. This change streamlines the build process and ensures
version generation is consistently managed by the CI pipeline.
@mauvehed mauvehed self-assigned this Dec 7, 2024
Copy link
Contributor

sourcery-ai bot commented Dec 7, 2024

Reviewer's Guide by Sourcery

This PR implements a new GitHub Actions workflow for automated release tagging and simplifies the local build process. The workflow handles version generation and build steps in the CI pipeline, while the local build command has been streamlined by removing the redundant version generation step.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Implement GitHub Actions workflow for automated release tagging
  • Create new workflow that triggers on push, pull request, and manual dispatch
  • Configure workflow to run on ubuntu-latest
  • Add steps for repository checkout, dependency installation, version generation, and build
.github/workflows/build-version.yml
Simplify local build process
  • Remove generate-version script from build command
  • Maintain generate-version script as separate command for CI usage
package.json
Update developer documentation with branch synchronization steps
  • Add instructions for switching to develop branch
  • Include steps for syncing develop branch with main
docs/DEVELOPERS.md

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time. You can also use
    this command to specify where the summary should be inserted.

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copy link

vercel bot commented Dec 7, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
yourip ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 7, 2024 8:42pm

Copy link
Contributor

@sourcery-ai sourcery-ai bot left a comment

Choose a reason for hiding this comment

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

Hey @mauvehed - I've reviewed your changes - here's some feedback:

Overall Comments:

  • The workflow triggers (push, pull_request, workflow_dispatch) seem too broad for a release tagging workflow. Consider limiting to specific events like release or tags if this is meant for releases.
  • Removing generate-version from the build script could cause issues with local builds. Consider adding a check in the build script to ensure version file exists or documenting the requirement to run generate-version first.
Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟢 Security: all looks good
  • 🟢 Testing: all looks good
  • 🟢 Complexity: all looks good
  • 🟢 Documentation: all looks good

Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@mauvehed mauvehed merged commit eab666b into main Dec 7, 2024
8 checks passed
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.

1 participant