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

Improve build pipeline #126

Merged
merged 39 commits into from
Apr 5, 2024
Merged

Improve build pipeline #126

merged 39 commits into from
Apr 5, 2024

Conversation

Mischback
Copy link
Owner

@Mischback Mischback commented Mar 28, 2024

  • some progress on Build pipeline #54
  • close Update pre-commit configuration #125
  • review Makefile:
    • add $(STAMP_NODE_READY) and $(TOX_VENV_INSTALLED) as order-only prerequisites as needed
    • FIXME: STYLE_DIR := $(THEME_DIR)/_src/style
    • FIXME: util/lint/prettier and util/lint/stylelint require $(STAMP_NODE_READY) as (order-only) prerequisite, as they are executed from the local NodeJS installation
    • remove development/debug-related echo statements
    • there are some places, where build artifacts are required for further processing (e.g. .build/_static/style.css). All files in .build are created/updated when running Sphinx / when the recipe for $(STAMP_SPHINX_COMPLETED) is executed. Is it safe to include an empty target like $(BUILD_DIR)/_static/style.css : $(STAMP_SPHINX_COMPLETED) ; in the Makefile to track this dependency? make's manual explicitly mentions the use case for artifacts, that are generated as side-effects of other recipes/targets, which is the case here (.build/_static/style.css is a side-effect of running Sphinx while executing the recipe for $(STAMP_SPHINX_COMPLETED))
      • Does not work as intended. Instead, grouped targets might be used. But probably not worth the hassle. I'm inclined to skipping this!
  • remove obsolete files in the build:
    • .build/genindex/index.html
    • .build/objects.inv
    • .build/search/index.html
    • .build/searchindex.js
    • .build/_static/pygments.css
    • .build/_static/style.css.map
    • check for hidden files within .build/, e.g. .doctrees/ and .buildinfo
    • while running in CI, Sphinx's linkcheck builder is used. Probably it is creating files output.json and output.txt in the .build/ directory
      • verify!
      • rm them!

@Mischback Mischback added area/repository Affects the repository structure lang/python type/improvement Improvement of an existing feature labels Mar 28, 2024
@Mischback Mischback added this to the Crawl milestone Mar 28, 2024
@Mischback Mischback self-assigned this Mar 28, 2024
@Mischback Mischback mentioned this pull request Mar 28, 2024
12 tasks
@Mischback Mischback force-pushed the feat/build-pipeline branch from 9532bb9 to f1d6d82 Compare April 1, 2024 20:18
@Mischback Mischback mentioned this pull request Apr 2, 2024
@Mischback Mischback merged commit ee0ab4d into development Apr 5, 2024
4 checks passed
@Mischback Mischback deleted the feat/build-pipeline branch April 5, 2024 07:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area/repository Affects the repository structure lang/python type/improvement Improvement of an existing feature
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update pre-commit configuration
1 participant