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

MULTI-GITTER PR: migration github-config-and-gitignore-changes #45

Merged
merged 1 commit into from
Dec 22, 2024

Conversation

rmenner
Copy link
Contributor

@rmenner rmenner commented Dec 16, 2024

Summary by Sourcery

Revise GitHub configuration files to enhance contribution guidelines, update CI workflows, and introduce a new deployment workflow for demo publishing.

CI:

  • Modify the testPublish.yml workflow to include a new build step and adjust the release conditions.

Deployment:

  • Introduce a new workflow publishDemo.yml for deploying demos on pull requests to the main branch.

Documentation:

  • Update the CONTRIBUTING.md and CODE_OF_CONDUCT.md files to improve clarity and consistency in guidelines for contributors.

@rmenner rmenner requested a review from a team as a code owner December 16, 2024 17:02
Copy link

sourcery-ai bot commented Dec 16, 2024

Reviewer's Guide by Sourcery

This PR implements various GitHub configuration changes across multiple files, including updates to contribution guidelines, issue templates, workflows, and repository settings. The changes focus on improving documentation clarity, standardizing commit message formats, and updating CI/CD configurations.

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

File-Level Changes

Change Details Files
Enhanced contribution guidelines with more detailed commit message formatting instructions
  • Added detailed commit message format structure with header, body, and footer sections
  • Clarified character length limits for commit messages
  • Added explanation of commit message prefixes and their impact on versioning
  • Improved documentation around breaking changes
.github/CONTRIBUTING.md
Updated repository settings and team permissions configuration
  • Reorganized team permissions section for better readability
  • Updated repository topics
  • Removed redundant repository description
  • Maintained branch protection rules
.github/settings.yml
Improved CI/CD workflow configurations
  • Added new build:test and build:release steps
  • Updated node version matrix
  • Fixed beta branch release condition
  • Added new publishDemo workflow
.github/workflows/testPublish.yml
.github/workflows/publishDemo.yml
Modernized issue templates with structured YAML format
  • Added new feature request template with structured fields
  • Added general support template with defined sections
  • Removed old markdown-based templates
  • Updated issue template configuration
.github/ISSUE_TEMPLATE/feature_request.yml
.github/ISSUE_TEMPLATE/general-support.yml
.github/ISSUE_TEMPLATE/config.yml

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

Surge demo deployment failed! 😭

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

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.

@jason-capsule42 jason-capsule42 merged commit 0da38d9 into main Dec 22, 2024
6 of 7 checks passed
@jason-capsule42 jason-capsule42 deleted the migration/github-config-and-gitignore-changes branch December 22, 2024 18:58
@blackfalcon
Copy link
Member

🎉 This PR is included in version 4.1.3 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Dec 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
released Completed work has been released
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants