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

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 issue templates and settings, remove outdated workflows, and update the node version used in the test and publish workflow to 22.

New Features:

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

CI:

  • Update the node version to 22 in the test and publish workflow.

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

sourcery-ai bot commented Jan 31, 2025

Reviewer's Guide by Sourcery

This pull request updates the project's templates to v2, which includes changes to the issue templates, pull request template, and CI workflow. The settings file was also updated to remove the label definitions, which are now handled by the issue templates.

Flow diagram of updated issue creation process

flowchart TD
    Start[User creates issue] --> Type{Select issue type}
    Type -->|Bug| Bug[Fill bug report template]
    Type -->|Feature| Feature[Fill feature request template]
    Type -->|Support| Support[Fill support request template]
    Type -->|Story| Story[Fill story template]
    Type -->|Task| Task[Fill task template]
    Type -->|Group| Group[Fill group template]

    Bug --> Project[Auto-added to project board]
    Feature --> Project
    Support --> Project
    Story --> Project
    Task --> Project
    Group --> Project

    Project --> Review[Auro team review]

    classDef new fill:#90EE90,stroke:#000
    class Bug,Feature,Support,Story,Task,Group new
Loading

File-Level Changes

Change Details Files
Updated the CI workflow to use node v20 and v22.
  • Updated the node version matrix to use 20 and 22 instead of 20.x and 22.x.
  • Updated the setup-node action to use node version 22 instead of 22.x.
.github/workflows/testPublish.yml
Removed the label definitions from the settings file.
  • Removed the label definitions from the settings file.
.github/settings.yml
Updated the pull request template.
  • Removed the summary and type of change sections from the pull request template.
.github/PULL_REQUEST_TEMPLATE.md
Added new issue templates.
  • Added a bug report issue template.
  • Added a general support issue template.
  • Added a story issue template.
  • Added a feature request issue template.
  • Added a task issue template.
  • Added 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
Added a security policy.
  • Added a security policy to the repository.
.github/SECURITY.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. 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