ci(workflow): add GitHub Actions workflow for merging develop into main on tag creation

[mauvehed]

Introduce a new GitHub Actions workflow to automate the merging of the develop branch into the main branch whenever a new tag is pushed. This ensures that the main branch is always up-to-date with the latest changes from develop when a release is tagged.

docs: add CODEOWNERS file and update README with usage instructions

Create a CODEOWNERS file to specify that all code is currently owned by @mauvehed, ensuring clear ownership and responsibility for code changes. Update the README to include detailed usage instructions for both development and accessing the website, providing users and developers with clear guidance on how to interact with the project. Additionally, acknowledge inspiration from Zate's project, giving credit and context to the project's development.

docs(DEVELOPERS.md): clarify branch creation instructions

Add clarification to the branch creation instructions in the DEVELOPERS.md file, specifying that creating and switching to a develop branch is a one-time setup step. This helps developers understand the process more clearly and avoid unnecessary repetition.

Summary by Sourcery

Introduce a GitHub Actions workflow to automate merging develop into main on tag creation, ensuring main is up-to-date. Update documentation with usage instructions, code ownership details, and branch creation clarification.

CI:

• Add a GitHub Actions workflow to automate merging the develop branch into the main branch upon new tag creation.

Documentation:

• Add a CODEOWNERS file to specify code ownership by @mauvehed.
• Update README with usage instructions for development and website access, and acknowledge inspiration from Zate's project.
• Clarify branch creation instructions in DEVELOPERS.md, specifying it as a one-time setup step.

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name	Status	Preview	Comments	Updated (UTC)
yourip	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Dec 7, 2024 8:23pm

[sourcery-ai]

Reviewer's Guide by Sourcery

This PR introduces a new GitHub Actions workflow for automating the merge of develop into main branch when tags are created, adds a CODEOWNERS file, and enhances documentation. The workflow is implemented using standard GitHub Actions syntax, with steps to checkout the repository, configure Git, and perform the merge operation. Documentation changes include expanded usage instructions in the README and clarified branch creation steps in DEVELOPERS.md.

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

File-Level Changes

Change	Details	Files
Implement GitHub Actions workflow for automated branch merging	Configure workflow to trigger on tag pushes matching 'v*' pattern Set up Git configuration with GitHub Actions bot credentials Implement merge process from develop to main branch with --no-ff flag Add GitHub token authentication for push operation	.github/workflows/merge-develop-to-main.yml
Enhance project documentation with usage instructions and acknowledgments	Add development environment setup reference Include instructions for accessing the website via browser and CLI Add examples for JSON and raw endpoint usage Include project acknowledgments section	README.md
Clarify development workflow documentation	Add note about develop branch creation being a one-time setup step	docs/DEVELOPERS.md
Establish code ownership guidelines	Create CODEOWNERS file assigning ownership to @mauvehed	CODEOWNERS

---

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

• Contact our support team for questions or feedback.
• Visit our documentation for detailed guides and information.
• Keep in touch with the Sourcery team by following us on X/Twitter, LinkedIn or GitHub.

[sourcery-ai]

Hey @mauvehed - I've reviewed your changes - here's some feedback:

Overall Comments:

• The CODEOWNERS file appears to be empty in the diff. Please ensure it contains the intended ownership rules mentioned in the PR description (@mauvehed).

Here's what I looked at during the review

• 🟡 General issues: 1 issue found
• 🟢 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 ✨

• X
• Mastodon
• LinkedIn
• Facebook

_{Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.}