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

Merged
merged 1 commit into from
Dec 23, 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.

CI:

  • Modify testPublish.yml workflow to refine the conditions for triggering the release job.

Deployment:

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

Documentation:

  • Update CONTRIBUTING.md to clarify the process for submitting issues and pull requests, including guidelines for commit messages and feature branch naming.

@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 several repository configuration changes and documentation updates. The changes primarily focus on standardizing GitHub repository settings, updating contribution guidelines, and improving the documentation structure. The PR also removes demo-related files and adds a new GitHub workflow for demo deployment.

No diagrams generated as the changes look simple and do not need a visual representation.

File-Level Changes

Change Details Files
Updated repository configuration and team permissions
  • Removed repository description placeholder
  • Updated topics list
  • Reorganized teams configuration section
  • Added team permissions with admin and push access levels
.github/settings.yml
Enhanced contribution guidelines and documentation
  • Added detailed commit message format guidelines
  • Clarified prefix usage for semantic versioning
  • Updated issue submission process
  • Added information about write access requests
.github/CONTRIBUTING.md
Updated GitHub workflow configurations
  • Fixed conditional statement in release workflow
  • Added Node.js version matrix for testing
  • Added new workflow for demo deployment
.github/workflows/testPublish.yml
.github/workflows/publishDemo.yml
.github/workflows/codeql.yml
Removed demo-related files
  • Removed demo API documentation
  • Removed demo JavaScript files
  • Removed demo index files
demo/api.md
demo/api.min.js
demo/index.md
demo/index.min.js

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:

  • Please explain the rationale for removing the demo files (api.md, api.min.js, index.md, index.min.js). Are these being replaced by something else or are they no longer needed?
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! 😭

@chrisfalaska chrisfalaska merged commit 1f23ecd into main Dec 23, 2024
6 of 7 checks passed
@chrisfalaska chrisfalaska deleted the migration/github-config-and-gitignore-changes branch December 23, 2024 19:09
@blackfalcon
Copy link
Member

🎉 This PR is included in version 3.1.2 🎉

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.

5 participants