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

chore: Add release drafter #47

Merged
merged 1 commit into from
Sep 8, 2024
Merged

Conversation

kienvo
Copy link
Member

@kienvo kienvo commented Sep 7, 2024

Resolves: #46

Summary by Sourcery

Integrate Release Drafter into the CI workflow to automate the generation of release notes for new releases.

CI:

  • Add a GitHub Actions workflow for Release Drafter to automate the release notes drafting process.

Copy link

sourcery-ai bot commented Sep 7, 2024

Reviewer's Guide by Sourcery

This pull request adds a Release Drafter workflow to automate the process of creating release notes. It introduces two new files: a GitHub Actions workflow file and a configuration file for the Release Drafter.

File-Level Changes

Change Details Files
Add GitHub Actions workflow for Release Drafter
  • Configure workflow to run on push to master and on pull request events
  • Set up permissions for the workflow
  • Define a job to update the release draft
  • Use release-drafter/[email protected] action
  • Set up environment variable for GitHub token
.github/workflows/release-drafter.yaml
Add Release Drafter configuration file
  • Define a simple template for the release notes
  • Include a 'What's Changed' section in the template
  • Use $CHANGES placeholder for automatically generated change list
.github/release-drafter.yml

Tips
  • Trigger a new Sourcery review by commenting @sourcery-ai review on the pull request.
  • Continue your discussion with Sourcery by replying directly to review comments.
  • You can change your review settings at any time by accessing your dashboard:
    • Enable or disable the Sourcery-generated pull request summary or reviewer's guide;
    • Change the review language;
  • You can always contact us if you have any questions or feedback.

Copy link

@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 @kienvo - I've reviewed your changes and they look great!

Here's what I looked at during the review
  • 🟢 General issues: all looks good
  • 🟡 Security: 1 issue found
  • 🟢 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 to tell me if it was helpful.

steps:

- name: Release Drafter
uses: release-drafter/[email protected]
Copy link

Choose a reason for hiding this comment

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

🚨 suggestion (security): Consider pinning the action to a specific commit hash

For improved security, consider pinning the release-drafter action to a specific commit hash instead of using a version tag. This ensures the exact version of the action being used and prevents potential supply chain attacks.

Suggested change
uses: release-drafter/release-drafter@v6.0.0
uses: release-drafter/release-drafter@45c556cec4e26c6595eb3ed050d4220c0e4c25d9

@mariobehling mariobehling merged commit ea14dd8 into fossasia:master Sep 8, 2024
1 of 2 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.

Add release drafter to repository
2 participants