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.

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

docs: release as asset #11429

Merged
merged 15 commits into from Dec 9, 2021
Merged

docs: release as asset #11429

merged 15 commits into from Dec 9, 2021

Conversation

viceice
Copy link
Member

@viceice viceice commented Aug 25, 2021

Changes:

Do the docs preparation step from https://github.com/renovatebot/renovatebot.github.io here and package files as release asset.

Context:

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please tick one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added/modified unit tests, or
  • No unit tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

@viceice viceice added the type:docs Documentation label Aug 25, 2021
rarkins
rarkins previously approved these changes Aug 25, 2021
.github/workflows/build-pr.yml Outdated Show resolved Hide resolved
@HonkingGoose
Copy link
Collaborator

I think I'm doing something wrong, or my setup is wrong somehow...

I first tried a normal build, that seems to work OK:

$ yarn build
yarn run v1.22.11
$ run-s clean generate:* compile:*
$ rimraf dist
$ node tools/generate-imports.mjs
generating imports
> data/extract.py
> data/node-js-schedule.json
> node_modules/emojibase-data/en/shortcodes/github.json
$ tsc -p tsconfig.app.json
Done in 11.38s.

Then I tried to build the docs, which seems to go wrong somehow. I don't see any new output in the tmp directory.

$ yarn build:docs
yarn run v1.22.11
$ run-s "release:prepare {@}"
$ node -r ts-node/register/transpile-only -- tools/generate-docs.ts
 INFO: generating docs
 INFO: * static
cp: dest is not a directory (too many sources)
Done in 6.37s.

What commands should I run to test this locally, and do you expect me to see, and where should I see the new files?

@viceice
Copy link
Member Author

viceice commented Aug 26, 2021

  • yarn clean should clean docs now
  • yarn build:docs shouuld work as expected now

yarn build isn't required for building docs

@HonkingGoose
Copy link
Collaborator

HonkingGoose commented Aug 26, 2021

yarn build isn't required for building docs

Oh I thought maybe you need to build the Renovate program first, so that we have things ready for the build:docs step.

I'll try this out locally later this day.

@HonkingGoose
Copy link
Collaborator

When I run yarn build:docs I get 3 WARN messages.

$ yarn build:docs
yarn run v1.22.11
$ run-s "release:prepare {@}"
$ node -r ts-node/register/transpile-only -- tools/generate-docs.ts
 INFO: generating docs
 INFO: * static
 INFO: * modules
 INFO: * platforms
 INFO: * versionigs
 INFO: * datasources
 INFO: * managers
 INFO: * presets
 WARN: Preset compatibility:additionalBranchPrefix has no description
 WARN: Preset helpers:disableTypesNodeMajor has no description
 WARN: Preset workarounds:mavenCommonsAncientVersion has no description
 INFO: * templates
 INFO: * configuration-options
 INFO: * self-hosted-configuration
 INFO: * json-schema
Done in 6.63s.

I've checked the source files, and we are missing descriptions for these presets. Do we need to add them?

@viceice
Copy link
Member Author

viceice commented Aug 26, 2021

We don't need them, but we should add them 🙃

@viceice viceice mentioned this pull request Aug 27, 2021
6 tasks
@HonkingGoose

This comment has been minimized.

@viceice
Copy link
Member Author

viceice commented Dec 9, 2021

working on it, it was just the merge on main, needs some adaptions now

Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
@viceice viceice changed the title docs: prepare release as asset docs: release as asset Dec 9, 2021
@viceice viceice marked this pull request as ready for review December 9, 2021 15:29
@viceice viceice requested a review from rarkins December 9, 2021 15:29
@viceice
Copy link
Member Author

viceice commented Dec 9, 2021

diff can be generated via:

diff -Naur renovatebot.github.io/docs/ renovate/tmp/docs -x CNAME -x LICENSE -x README -x *.css -x *.js -x index.md -x merge-confidence.md

docs/usage/templates.md Show resolved Hide resolved
docs/usage/templates.md Show resolved Hide resolved
lib/datasource/types.ts Outdated Show resolved Hide resolved
tools/docs/manager.ts Show resolved Hide resolved
Co-authored-by: HonkingGoose <34918129+HonkingGoose@users.noreply.github.com>
@HonkingGoose

This comment has been minimized.

@viceice
Copy link
Member Author

viceice commented Dec 9, 2021

You don't need to verify, you can trust my diff posted on slack. 😉

@viceice viceice merged commit e4c938b into main Dec 9, 2021
@viceice viceice deleted the docs/docusaurus branch December 9, 2021 20:12
@viceice
Copy link
Member Author

viceice commented Dec 9, 2021

Do we have a ready PR to trigger a release. 🤭

@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 30.1.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

@viceice viceice mentioned this pull request Dec 10, 2021
6 tasks
@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jan 10, 2022
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
type:docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants