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

AURO MIGRATION: Update Templates to v2 #175

Closed
wants to merge 2 commits into from

Conversation

chrisfalaska
Copy link
Contributor

@chrisfalaska chrisfalaska commented Jan 31, 2025

Resolves AlaskaAirlines/auro-cli#30

Summary by Sourcery

Update Auro templates to v2, update workflows, and add issue templates.

Build:

  • Update Node version to 20 and 22.

CI:

  • Update CI workflows to use Node 22 for setup and remove node version matrix.

Documentation:

  • Add SECURITY.md file with security policy.
  • Remove outdated labels from settings.

Tests:

  • Add new issue templates for bug reports, general support, stories, feature requests, tasks, and grouping issues.

@chrisfalaska chrisfalaska requested a review from a team as a code owner January 31, 2025 21:39
@chrisfalaska chrisfalaska self-assigned this Jan 31, 2025
Copy link

sourcery-ai bot commented Jan 31, 2025

Reviewer's Guide by Sourcery

This pull request updates the project's configuration files to align with the v2 template. This includes changes to the settings, pull request template, test publishing workflow, and issue templates.

Flow diagram of updated issue templates structure

flowchart TD
    Issue[New Issue]
    Bug[Bug Report]
    Feature[Feature Request]
    Support[Support Request]
    Story[Story]
    Task[Task]
    Group[Group]

    Issue --> Bug
    Issue --> Feature
    Issue --> Support
    Issue --> Story
    Issue --> Task
    Issue --> Group

    subgraph Templates
        Bug --> Project[Project: AlaskaAirlines/19]
        Feature --> Project
        Support --> Project
        Story --> Project
        Task --> Project
        Group --> Project
    end

    style Templates fill:#f0f0f0,stroke:#333,stroke-width:2px
Loading

File-Level Changes

Change Details Files
Updates the branch protection for the beta branch.
  • Removes the label definitions from the settings file.
.github/settings.yml
Simplifies the pull request template.
  • Removes the section that defines the type of change.
.github/PULL_REQUEST_TEMPLATE.md
Updates the test publishing workflow to use node versions 20 and 22.
  • Removes the '.x' from the node version matrix.
  • Removes the '.x' from the node version setup.
.github/workflows/testPublish.yml
Adds new issue templates.
  • Adds a bug report issue template.
  • Adds a general support issue template.
  • Adds a story issue template.
  • Adds a feature request issue template.
  • Adds a task issue template.
  • Adds a group issue template.
.github/ISSUE_TEMPLATE/bug_report.yaml
.github/ISSUE_TEMPLATE/general-support.yaml
.github/ISSUE_TEMPLATE/story.yaml
.github/ISSUE_TEMPLATE/feature_request.yaml
.github/ISSUE_TEMPLATE/task.yaml
.github/ISSUE_TEMPLATE/group.yaml
Adds a security policy.
  • Adds a security policy to the repository.
.github/SECURITY.md
Removes old issue templates.
  • Removes the old bug report issue template.
  • Removes the old feature request issue template.
  • Removes the old general support issue template.
.github/ISSUE_TEMPLATE/bug_report.yml
.github/ISSUE_TEMPLATE/feature_request.yml
.github/ISSUE_TEMPLATE/general-support.yml
Removes old workflows.
  • Removes the add to project workflow.
  • Removes the auto assign workflow.
.github/workflows/addToProject.yml
.github/workflows/autoAssign.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. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the 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 exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!
  • Generate a plan of action for an issue: Comment @sourcery-ai plan on
    an issue to generate a plan of action for it.

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

github-actions bot commented Jan 31, 2025

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 @chrisfalaska - 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.

@chrisfalaska
Copy link
Contributor Author

We identified an issue with the auro-cli Multi-Gitter, which committed the changes directly to main, bypassing the PR process.

We will refine the Multi-Gitter process to prevent this in the future.

As a result, the changes were committed, making this PR unnecessary. Closing PR.

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.

Migrate all .github config files from template into each repository
1 participant