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

Merged
merged 1 commit into from
Dec 17, 2024

Conversation

rmenner
Copy link
Contributor

@rmenner rmenner commented Dec 16, 2024

Summary by Sourcery

Revise GitHub configuration files to enhance contribution guidelines, improve CI workflows, and remove outdated demo documentation.

Enhancements:

  • Update the CONTRIBUTING.md file to clarify the process for submitting issues and pull requests, including the addition of guidelines for commit message formats and branch naming conventions.
  • Revise the CODE_OF_CONDUCT.md to improve readability and ensure consistent formatting.

CI:

  • Modify the testPublish.yml workflow to refine the conditions for triggering releases and adjust node version matrix formatting.
  • Add a new publishDemo.yml workflow to automate the deployment of demo environments on pull requests to the main branch.

Documentation:

  • Remove outdated demo documentation files, including api.md, api.min.js, index.md, and index.min.js, to clean up the repository.

@rmenner rmenner requested a review from a team as a code owner December 16, 2024 17:01
Copy link

sourcery-ai bot commented Dec 16, 2024

Reviewer's Guide by Sourcery

This PR implements a series of GitHub configuration updates and documentation changes. The changes primarily focus on standardizing repository settings, updating contribution guidelines, and improving the pull request workflow documentation. The PR also includes the removal of demo-related files and the addition of a new GitHub Action 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
Enhanced contribution guidelines and documentation
  • Added clearer instructions about issue submission process
  • Updated pull request access permissions documentation
  • Enhanced commit message format documentation with detailed header, body, and footer sections
  • Improved explanation of commit type prefixes and their impact on versioning
.github/CONTRIBUTING.md
Repository settings configuration updates
  • Removed redundant repository description
  • Updated topics list
  • Reorganized team permissions section
  • Maintained existing branch protection rules
.github/settings.yml
GitHub Actions workflow improvements
  • Fixed conditional logic in release workflow
  • Added new publishDemo workflow for demo deployment
  • Updated CodeQL workflow formatting
.github/workflows/testPublish.yml
.github/workflows/codeql.yml
.github/workflows/publishDemo.yml
Cleanup of demo-related files
  • Removed demo documentation files
  • Removed demo JavaScript 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

Surge demo deployment failed! 😭

1 similar comment
Copy link

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

@jason-capsule42 jason-capsule42 merged commit 8806a60 into main Dec 17, 2024
6 of 8 checks passed
@jason-capsule42 jason-capsule42 deleted the migration/github-config-and-gitignore-changes branch December 17, 2024 17:29
@blackfalcon
Copy link
Member

🎉 This PR is included in version 3.2.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@blackfalcon blackfalcon added the released Completed work has been released label Dec 17, 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.

4 participants