Skip to content

Fix docs deployment workflow #323

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.

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

Merged
merged 2 commits into from
Aug 5, 2022
Merged

Fix docs deployment workflow #323

merged 2 commits into from
Aug 5, 2022

Conversation

joshklop
Copy link
Contributor

@joshklop joshklop commented Aug 4, 2022

Changes:

  • Install yarn symlink to the current directory and call it. This way github actions can't insert its own version of yarn.

Types of changes

What types of changes does your code introduce?

  • Build related changes

Note: this is probably the fifth or sixth time we have tried to fix something related to github actions and node dependencies. If you could test it out on your end so we can avoid another PR that would be awesome (works on my end):

cd docs
rm -r node_modules
nvm use # nvm install if prompted
corepack enable yarn
yarn install
yarn start

If it builds and runs successfully, we should be good to go.

To ensure the github workflow doesn't insert its own version of yarn,
we install yarn to the working directory and call it there.
@codecov
Copy link

codecov bot commented Aug 4, 2022

Codecov Report

Merging #323 (86319b0) into main (e7d92c8) will not change coverage.
The diff coverage is n/a.

@@            Coverage Diff            @@
##              main      #323   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files           60        60           
  Lines         6777      6775    -2     
=========================================
- Hits          6777      6775    -2     
Flag Coverage Δ
unittests 100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
pkg/crypto/weierstrass/weierstrass.go 100.00% <0.00%> (ø)

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

Copy link
Contributor

@adriantpaez adriantpaez left a comment

Choose a reason for hiding this comment

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

I think we need to add the yarn and yarnpkg executables to the .gitignore file

@joshklop
Copy link
Contributor Author

joshklop commented Aug 5, 2022

Thanks for pointing that out @adriantpaez.

I just read about the yarnPath param in the .yarnrc.yml config file and the .yarn/releases directory. With these, yarn will automatically switch to use the correct version without you needing to change anything.

This way you don't need to mess with the version on your machine. It is stored in the repository.

@joshklop joshklop merged commit 4430423 into main Aug 5, 2022
@IronGauntlets IronGauntlets deleted the josh/fix-yarn-workflow branch August 5, 2022 12:26
IronGauntlets pushed a commit that referenced this pull request Aug 18, 2022
Github actions does not use the right version of yarn. This also ensures developers are using the same yarn version.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants