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

Open
wants to merge 2 commits into
base: main
Choose a base branch
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 and migrate GitHub settings, issue templates, and workflows.

Documentation:

  • Add a SECURITY.md file with information on reporting security vulnerabilities.

Tests:

  • Update the test and publish workflow to use Node.js versions 20 and 22.

Chores:

  • Remove outdated GitHub labels and settings.

@chrisfalaska chrisfalaska requested a review from a team as a code owner January 31, 2025 21:40
@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 repository's templates and configurations to align with Auro's version 2 standards. It removes extensive label definitions from the GitHub settings, simplifies the pull request template, updates Node.js version specifications in workflows, and introduces new issue templates in YAML format. Additionally, it adds a security policy document and removes old issue templates and unused workflows.

Flow diagram of issue template structure

flowchart LR
    issue[New Issue]-->type{Issue Type}
    type-->bug[Bug Report]
    type-->feature[Feature Request]
    type-->support[Support Request]
    type-->story[Story]
    type-->task[Task]
    type-->group[Group]

    bug-->project[Project Board]
    feature-->project
    support-->project
    story-->project
    task-->project
    group-->project

    style issue fill:#f9f,stroke:#333,stroke-width:2px
    style project fill:#bbf,stroke:#333,stroke-width:2px
Loading

File-Level Changes

Change Details Files
Removed extensive label definitions from GitHub settings
  • Deleted label definitions for issues and pull requests
  • Removed color and description settings for labels
  • Eliminated aliases for labels
.github/settings.yml
Simplified pull request template
  • Removed detailed sections for change summary and type of change
  • Kept only the essential summary section
.github/PULL_REQUEST_TEMPLATE.md
Updated Node.js version specification in GitHub Actions workflow
  • Changed node-version from '20.x, 22.x' to '20, 22'
  • Updated node-version from '22.x' to '22'
.github/workflows/testPublish.yml
Added new issue templates in YAML format
  • Created bug report template
  • Created general support request template
  • Created story template
  • Created feature request template
  • Created task template
  • Created group 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 security policy document
  • Introduced SECURITY.md file with guidelines for reporting security issues
.github/SECURITY.md
Removed old issue templates in Markdown format
  • Deleted bug report and feature request templates in Markdown
  • Removed general support template in Markdown
.github/ISSUE_TEMPLATE/bug_report.md
.github/ISSUE_TEMPLATE/feature_request.md
.github/ISSUE_TEMPLATE/general-support.md
Removed unused GitHub Actions workflows
  • Deleted addToProject.yml workflow
  • Deleted autoAssign.yml 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 - here's some feedback:

Overall Comments:

  • Consider retaining some structure in the PR template (like type of change and checklist sections) to ensure PRs contain sufficient detail for reviewers.
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.

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