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 #216

Merged
merged 1 commit into from
Dec 19, 2024

Conversation

rmenner
Copy link
Contributor

@rmenner rmenner commented Dec 16, 2024

Summary by Sourcery

Update GitHub configuration files, including CONTRIBUTING.md, CODE_OF_CONDUCT.md, and workflow scripts, to enhance clarity and automate demo deployments.

CI:

  • Modify the testPublish.yml workflow to ensure it triggers on push and pull request events for the main and beta branches, and update the node version specification.

Deployment:

  • Introduce a new publishDemo.yml workflow to automate the deployment of demo environments on pull requests to the main branch.

Documentation:

  • Update the CONTRIBUTING.md file to include additional guidelines for Alaska Airlines employees and clarify the process for submitting issues and pull requests.
  • Revise the CODE_OF_CONDUCT.md to improve clarity and maintain consistency in formatting.

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

sourcery-ai bot commented Dec 16, 2024

Reviewer's Guide by Sourcery

This PR updates various GitHub configuration files and templates to align with current standards and best practices. The changes primarily focus on improving documentation, updating issue templates, and enhancing the contribution workflow process.

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

File-Level Changes

Change Details Files
Enhanced contributing guidelines with clearer instructions and new sections
  • Added link to Innersourcing Flow Guide for Alaska Airlines employees
  • Updated instructions for submitting issues and pull requests
  • Added explicit warning against using git pull on feature branches
  • Enhanced commit message format documentation with detailed examples
  • Added section about commit message body content
.github/CONTRIBUTING.md
Updated repository settings and team permissions configuration
  • Added team permission configurations for auro-team and nonauroteamwriteaccess
  • Updated repository topics
  • Modified branch protection settings
.github/settings.yml
Improved issue templates and workflow configurations
  • Updated issue template labels and formatting
  • Added new publishDemo workflow
  • Enhanced test and publish workflow with better conditional logic
  • Updated node version specifications
.github/ISSUE_TEMPLATE/bug_report.yml
.github/ISSUE_TEMPLATE/feature_request.yml
.github/ISSUE_TEMPLATE/general-support.yml
.github/workflows/testPublish.yml
.github/workflows/publishDemo.yml
Updated Code of Conduct with minor refinements
  • Removed specific email contact information
  • Refined formatting and structure
.github/CODE_OF_CONDUCT.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

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.

@rmenner rmenner merged commit 42f339c into main Dec 19, 2024
6 of 7 checks passed
@rmenner rmenner deleted the migration/github-config-and-gitignore-changes branch December 19, 2024 21:44
@blackfalcon
Copy link
Member

🎉 This PR is included in version 2.2.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Dec 19, 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