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

Merged
merged 1 commit into from
Dec 22, 2024

Conversation

rmenner
Copy link
Contributor

@rmenner rmenner commented Dec 16, 2024

Summary by Sourcery

Update GitHub configuration files to improve contribution guidelines, issue templates, and CI workflows. Add a new workflow for demo deployment and enhance documentation for clarity.

CI:

  • Modify the testPublish.yml workflow to ensure compatibility with Node.js version 20.x and improve the release condition logic.

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 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 readability without changing the core content.
  • Enhance the ISSUE_TEMPLATE files by adding exit criteria sections and improving descriptions for better clarity.

@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 updates various GitHub configuration files and templates to improve the contribution process and repository management. The changes include updates to issue templates, workflow configurations, and documentation files to align with current best practices and requirements.

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 clearer instructions and process improvements
  • Added link to Innersourcing Flow Guide for Alaska Airlines employees
  • Updated issue submission process with 48-hour response time expectation
  • Added warning against using git pull on feature branches
  • Expanded commit message format documentation with detailed examples
  • Clarified the process for submitting pull requests
.github/CONTRIBUTING.md
Updated GitHub repository settings and team permissions
  • Reorganized team permissions configuration
  • Added new UI Update label
  • Updated branch protection rules
  • Removed repository description
.github/settings.yml
Improved issue templates with better structure and guidance
  • Added exit criteria section to templates
  • Enhanced bug report template with screenshot guidance
  • Updated label configurations
  • Improved template formatting and consistency
.github/ISSUE_TEMPLATE/bug_report.yml
.github/ISSUE_TEMPLATE/feature_request.yml
.github/ISSUE_TEMPLATE/general-support.yml
Updated GitHub Actions workflow configurations
  • Added new publishDemo workflow
  • Fixed beta branch condition in testPublish workflow
  • Updated Node.js version specification
.github/workflows/testPublish.yml
.github/workflows/codeql.yml
.github/workflows/publishDemo.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

@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:

  • Could you explain the reasoning behind removing the demo files (api.md, api.min.js, index.md, index.min.js)? This seems unrelated to the documentation updates and may impact functionality.
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.

Copy link

Surge demo deployment failed! 😭

@jason-capsule42 jason-capsule42 merged commit 60f57e3 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:57
@blackfalcon
Copy link
Member

🎉 This PR is included in version 4.3.1 🎉

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.

5 participants