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

Merged
merged 1 commit into from
Dec 20, 2024

Conversation

rmenner
Copy link
Contributor

@rmenner rmenner commented Dec 16, 2024

Summary by Sourcery

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

Enhancements:

  • Update the CONTRIBUTING.md file to include additional guidance for Alaska Airlines employees and clarify the process for submitting issues and pull requests.
  • Revise the CODE_OF_CONDUCT.md to improve readability and update the enforcement contact information.
  • Enhance the ISSUE_TEMPLATE files by adding an 'exit criteria' section to better define when an issue can be closed.

CI:

  • Modify the testPublish.yml workflow to ensure it only releases on push to main or beta branches and update the Node.js version specification.

Deployment:

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

@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 implements various GitHub configuration changes and updates across multiple files. The changes focus on improving documentation, updating templates, and standardizing repository settings. Key updates include enhanced contributing guidelines, modified issue templates, and new workflow configurations.

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 formatting improvements
  • Added link to Innersourcing Flow Guide for Alaska Airlines employees
  • Improved clarity around feature requests and issue submission process
  • Enhanced documentation about commit message format and structure
  • Added detailed examples for commit messages with body content
.github/CONTRIBUTING.md
Updated repository settings and team permissions configuration
  • Removed redundant repository description
  • Updated topics list
  • Reorganized team permissions section
  • Modified branch protection settings
.github/settings.yml
Enhanced issue templates with additional fields and improved structure
  • Added exit criteria field to feature request template
  • Added exit criteria field to general support template
  • Updated template formatting and descriptions
.github/ISSUE_TEMPLATE/feature_request.yml
.github/ISSUE_TEMPLATE/general-support.yml
Added new workflow configuration for demo deployment
  • Created new publishDemo workflow for deploying demos on pull requests
  • Added surge token configuration
.github/workflows/publishDemo.yml
Updated Code of Conduct with more inclusive language
  • Removed specific contact email
  • Improved formatting and readability
  • Updated enforcement section language
.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 - here's some feedback:

Overall Comments:

  • Please provide context for the removal of the demo files (api.md, api.min.js, index.md, index.min.js). Are these being replaced or moved elsewhere?
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 12a717e into main Dec 20, 2024
6 of 7 checks passed
@jason-capsule42 jason-capsule42 deleted the migration/github-config-and-gitignore-changes branch December 20, 2024 20:23
@blackfalcon
Copy link
Member

🎉 This PR is included in version 2.4.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

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