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.

Sign up for GitHub

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

attempt at fixing versions in user-facing docs #1544

Merged
merged 1 commit into from
Feb 10, 2022
Merged

attempt at fixing versions in user-facing docs #1544

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 3 additions & 1 deletion .github/workflows/deploy-website.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
with:
fetch-depth: 0
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/actions/checkout

# Number of commits to fetch. 0 indicates all history for all branches and tags.
# Default: 1

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't understand why this number is wrong ...but let's try!

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

https://github.com/sbt/sbt-dynver#setup

In CI, you may need to run git fetch --unshallow (or, sometimes, git fetch --depth=10000), to avoid situations where a shallow clone will result in the last tag not being fetched. Additionally git fetch --tags if the repo is cloned with --no-tags.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

For the record the release job gets proper versions because it does an explicit unshallow

scalafix/.github/workflows/release.yml

Line 13 in 6d991eb

- run: git fetch --unshallow

I guess either approach is correct. The unshallow is maybe a bit more efficient but I like that fetch-depth is a flag on the checkout as it's more apparent.

- uses: olafurpg/setup-scala@v13
- name: Publish ${{ github.ref }}
run: sbt docs/docusaurusPublishGhpages
env:
GITHUB_DEPLOY_KEY: ${{ secrets.DOC }}
GITHUB_DEPLOY_KEY: ${{ secrets.DOC }}