Sync docs workflow #519
Open
Sync docs workflow #519
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…k to 0xsequence/docs This commit introduces a new GitHub Actions workflow that automates the synchronization of documentation files from the marketplace-sdk repository to the 0xsequence/docs repository. The workflow triggers on pushes to the main or master branches and allows for manual execution. It includes steps for checking out both repositories, copying documentation files while excluding specific internal setup documentation, and creating a pull request if changes are detected. The workflow ensures that documentation remains up-to-date and accurately reflects the latest changes in the SDK.
This commit introduces a new Bash script, setup-docs-sync.sh, designed to facilitate the setup of an automated documentation synchronization workflow between the marketplace-sdk repository and the 0xsequence/docs repository. The script includes checks for necessary configurations, such as the presence of a GitHub Personal Access Token and the required workflow file. It provides step-by-step instructions for users to create and validate the token, as well as guidance on testing the workflow. The script enhances the documentation process by ensuring that users can easily configure and test the sync setup.
This commit introduces a comprehensive guide for setting up automated documentation synchronization between the marketplace-sdk and 0xsequence/docs repositories using GitHub Actions. The guide details the prerequisites, workflow triggers, steps involved, and troubleshooting tips to ensure a smooth setup process. It also includes best practices for maintaining documentation accuracy and security considerations for using Personal Access Tokens. This documentation aims to facilitate user understanding and streamline the sync process.
- Rename sdk/docs/DOCS-SYNC-SETUP.md to README.md so GitHub automatically displays the documentation sync setup guide when viewing the sdk/docs/ directory - Remove accidental test-sync file from docs directory - This enables proper markdown rendering in GitHub's web interface for the docs directory
- Update sync-docs.yml workflow to exclude README.md instead of DOCS-SYNC-SETUP.md - Update setup-docs-sync.sh script references to point to sdk/docs/README.md - Maintain exclusion of setup guide from documentation sync to prevent overwriting target repository's README - All references now correctly point to the renamed file location
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.