docs: delete duplicate root CONTRIBUTING.md and update release instructions#985
docs: delete duplicate root CONTRIBUTING.md and update release instructions#985Aaron ("AJ") Steers (aaronsteers) wants to merge 2 commits intomainfrom
Conversation
…release-drafter references Co-Authored-By: AJ Steers <aj@airbyte.io>
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
👋 Greetings, Airbyte Team Member!Here are some helpful tips and reminders for your convenience. 💡 Show Tips and TricksTesting This PyAirbyte VersionYou can test this version of PyAirbyte using the following: # Run PyAirbyte CLI from this branch:
uvx --from 'git+https://github.com/airbytehq/PyAirbyte.git@devin/1771619414-fix-contributing-docs' pyairbyte --help
# Install PyAirbyte from this branch for development:
pip install 'git+https://github.com/airbytehq/PyAirbyte.git@devin/1771619414-fix-contributing-docs'PR Slash CommandsAirbyte Maintainers can execute the following slash commands on your PR:
📚 Show Repo GuidanceHelpful ResourcesCommunity SupportQuestions? Join the #pyairbyte channel in our Slack workspace. |
CONTRIBUTING.md
Outdated
There was a problem hiding this comment.
Delete this file. It is a dupe that should not have been created. Merge into docs/CONTRIBUTING.md and make sure docs/CONTRIBUTING.md is linked from the README.md.
There was a problem hiding this comment.
Done — deleted root CONTRIBUTING.md. The docs/CONTRIBUTING.md already has the updated Release section with the semantic-pr-release-drafter link, and README.md already links to docs/CONTRIBUTING.md at line 64.
…d as canonical Co-Authored-By: AJ Steers <aj@airbyte.io>
📝 WalkthroughWalkthroughRemoved content from Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~8 minutes 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/CONTRIBUTING.md`:
- Around line 37-39: Update the Releasing Guide link to point to a stable
reference (a specific tag or commit SHA) instead of the main branch by replacing
the current URL to the `aaronsteers/semantic-pr-release-drafter` docs with a
tag/commit-based URL; also verify in your CI/workflows that the tool referenced
in the docs (semantic-pr-release-drafter) is actually configured—check workflow
files that currently reference `aaronsteers/n@v1.0.0` and confirm whether they
call `semantic-pr-release-drafter` (or add the proper action/version) so the
docs and workflows match.
| This project uses [`semantic-pr-release-drafter`](https://github.com/aaronsteers/semantic-pr-release-drafter) for automated release management. To release, simply click "`Edit`" on the latest release draft from the [releases page](https://github.com/airbytehq/PyAirbyte/releases), and then click "`Publish release`". This publish operation will trigger all necessary downstream publish operations. | ||
|
|
||
| To publish to PyPi, simply [create a GitHub Release](https://github.com/airbytehq/PyAirbyte/releases/new) with the correct version. Once you publish the release on GitHub it will automatically trigger a PyPi publish workflow in GitHub actions. | ||
| ℹ️ For more detailed instructions, please see the [Releasing Guide](https://github.com/aaronsteers/semantic-pr-release-drafter/blob/main/docs/releasing.md). |
There was a problem hiding this comment.
🧩 Analysis chain
🏁 Script executed:
#!/bin/bash
# Check if semantic-pr-release-drafter is referenced in GitHub workflows
rg -rn "semantic-pr-release-drafter" .github/ 2>/dev/null || echo "No matches found in .github/"Repository: airbytehq/PyAirbyte
Length of output: 208
🏁 Script executed:
#!/bin/bash
# Verify the exact content of docs/CONTRIBUTING.md around lines 37-39
# First, let's see how many lines the file has
wc -l docs/CONTRIBUTING.md
# Then read the relevant section
sed -n '30,45p' docs/CONTRIBUTING.mdRepository: airbytehq/PyAirbyte
Length of output: 1111
🏁 Script executed:
#!/bin/bash
# Check the entire docs/CONTRIBUTING.md to ensure we capture the context
cat -n docs/CONTRIBUTING.md | grep -A 5 -B 5 "semantic-pr-release-drafter"Repository: airbytehq/PyAirbyte
Length of output: 1079
Pin the Releasing Guide link to a stable ref instead of main.
The Releasing Guide URL targets the main branch of aaronsteers/semantic-pr-release-drafter — if that branch is renamed, the file is moved, or the repo is reorganized, the link silently 404s. Would you consider linking to a specific tag or commit SHA instead?
-ℹ️ For more detailed instructions, please see the [Releasing Guide](https://github.com/aaronsteers/semantic-pr-release-drafter/blob/main/docs/releasing.md).
+ℹ️ For more detailed instructions, please see the [Releasing Guide](https://github.com/aaronsteers/semantic-pr-release-drafter/blob/<TAG_OR_SHA>/docs/releasing.md).Additionally, I noticed that semantic-pr-release-drafter isn't explicitly referenced in the workflows (the release workflow uses aaronsteers/n@v1.0.0). Could you confirm the tool is actually configured before these docs land? It would be good to verify the connection between what the docs describe and what's running in the CI.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/CONTRIBUTING.md` around lines 37 - 39, Update the Releasing Guide link
to point to a stable reference (a specific tag or commit SHA) instead of the
main branch by replacing the current URL to the
`aaronsteers/semantic-pr-release-drafter` docs with a tag/commit-based URL; also
verify in your CI/workflows that the tool referenced in the docs
(semantic-pr-release-drafter) is actually configured—check workflow files that
currently reference `aaronsteers/n@v1.0.0` and confirm whether they call
`semantic-pr-release-drafter` (or add the proper action/version) so the docs and
workflows match.
devin-ai-integration
bot
changed the title
1 participant
docs: delete duplicate root CONTRIBUTING.md and update release instructions
Summary
A previous PR (#984) added a root-level
CONTRIBUTING.mdwith a Releasing section, but this repo already had detailed contributing docs atdocs/CONTRIBUTING.md(linked fromREADME.mdat line 64). This PR fixes that by:CONTRIBUTING.md—docs/CONTRIBUTING.mdis the canonical location, already linked from the README.## Releasesection indocs/CONTRIBUTING.mdto referencesemantic-pr-release-drafterand the centralized Releasing Guide, replacing the old manual "create a GitHub Release" instructions.The repo-specific warnings (Cmd+Enter gotcha) and notes (uv-dynamic-versioning) are preserved unchanged.
Updates since last revision
CONTRIBUTING.mdentirely per reviewer feedback (previously was cross-referencingdocs/CONTRIBUTING.md; now just removed as a duplicate).Review & Testing Checklist for Human
semantic-pr-release-drafteris configured in this repo and that editing/publishing a draft release triggers the PyPI publish workflow (i.e., the new instructions indocs/CONTRIBUTING.mdare accurate)/releases/newis no longer the intended workflowNotes
Requested by: Aaron ("AJ") Steers (@aaronsteers)
Devin session
Summary by CodeRabbit