Add pkgdown configuration and update GitHub Actions for deployment #224
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
There was a problem hiding this comment.
Pull Request Overview
This PR sets up pkgdown documentation site deployment for the sccomp R package. The changes configure pkgdown to generate a documentation website and deploy it to GitHub Pages using GitHub Actions.
- Adds pkgdown configuration file with Bootstrap 5 template and deployment URL
- Updates package description to include the documentation website URL
- Modernizes GitHub Actions workflow to use direct deployment instead of the artifact-based approach
- Excludes pkgdown-related files from R package builds
Reviewed Changes
Copilot reviewed 4 out of 5 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| _pkgdown.yml | Adds pkgdown configuration with site URL and Bootstrap 5 template |
| DESCRIPTION | Updates URL field to include the pkgdown documentation site |
| .github/workflows/workflow_with_cmdstanr.yml | Replaces artifact-based deployment with direct GitHub Pages deployment |
| .Rbuildignore | Excludes pkgdown configuration and output files from package builds |
Comment on lines
+133
to
+138
| if: github.event_name != 'pull_request' || github.head_ref == 'fix-github-pages' | ||
| uses: JamesIves/github-pages-deploy-action@v4.5.0 | ||
| with: | ||
| path: ./docs | ||
|
|
||
| # Deploy job | ||
| deploy: | ||
| needs: build | ||
| permissions: | ||
| pages: write | ||
| id-token: write | ||
| environment: | ||
| name: github-pages | ||
| url: ${{ steps.deployment.outputs.page_url }} | ||
| runs-on: ubuntu-latest | ||
| steps: | ||
| - name: Deploy to GitHub Pages | ||
| id: deployment | ||
| uses: actions/deploy-pages@v4 | ||
| clean: false | ||
| branch: gh-pages | ||
| folder: docs |
There was a problem hiding this comment.
The hardcoded branch name 'fix-github-pages' in the conditional makes the workflow fragile. Consider using a more generic approach or removing this specific branch exception to avoid maintenance issues when branch names change.
Copilot uses AI. Check for mistakes.
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.
No description provided.