Commit graph

3,905 commits

Author SHA1 Message Date
Noel Miller
f033bacfb1 minor edits with requested changes 2024-10-18 18:46:51 -05:00
Noel Miller
fdbf97a3c0 update tips to include deploy input 2024-10-18 16:28:30 -05:00
Noel Miller
7304fe5a0f
Merge branch 'main' into pelican_decouple_build_workflow 2024-10-17 12:07:00 -05:00
Noel Miller
ab07896507
Merge pull request #1 from seanh/pelican_decouple_build_workflow-single-file
Combine `build.yml` and `github_pages.yml`
2024-10-17 12:03:02 -05:00
Justin Mayer
31264498e1
Add FAQ entry about theme overrides (#3406)
Some checks failed
build / Test - 3.10 - macos (push) Has been cancelled
build / Test - 3.11 - macos (push) Has been cancelled
build / Test - 3.12 - macos (push) Has been cancelled
build / Test - 3.10 - ubuntu (push) Has been cancelled
build / Test - 3.11 - ubuntu (push) Has been cancelled
build / Test - 3.12 - ubuntu (push) Has been cancelled
build / Test - 3.8 - ubuntu (push) Has been cancelled
build / Test - 3.9 - ubuntu (push) Has been cancelled
build / Test - 3.10 - windows (push) Has been cancelled
build / Test - 3.11 - windows (push) Has been cancelled
build / Test - 3.12 - windows (push) Has been cancelled
build / Lint (push) Has been cancelled
build / Test build (push) Has been cancelled
build / Build docs (push) Has been cancelled
build / Deploy (push) Has been cancelled
2024-10-17 09:13:39 -07:00
Sean Hammond
f9a0d9e56b
Combine build.yml and github_pages.yml
Combine `build.yml` and `github_pages.yml` into a single workflow file.
Having `build.yml` be a separate workflow file that `github_pages.yml`
calls has two problems:

1. All the inputs (and their types, descriptions, defaults) have to be
   duplicated in the two workflow files.

2. The reference to `@main` in `uses: "getpelican/pelican/.github/workflows/build.yml@main"`
   in the `github_pages.yml` workflow makes development and testing
   awkward.

For example let's say you want to send a pull request that contains
changes to `build.yml` and that also requires changes to
`github_pages.yml` at the same time. The problem is that the
`github_pages.yml` on your PR branch will still contain the reference to
`build.yml` `@main` so if you try to test the branch's version of
`github_pages.yml` it'll call the version of `build.yml` from `main` not
from the PR branch and will fail.

This commit move the build job from `build.yml` into `github_pages.yml`
but makes the deploy job optional: it adds a `deploy` input and will
only run the deploy job if `deploy = true` is passed.

Previously a user could test their build without deploying it by calling
the separate `build.yml` workflow. Now they can do it by calling the
`github_pages.yml` workflow and passing `deploy=false`.

This commit also moves the `concurrency` stuff from the workflow level
to the deploy level: it's okay to have multiple build jobs running
concurrently, just not multiple deploy jobs.
2024-10-14 17:20:25 +01:00
Frederik Elwert
92050d90bc Add FAQ regarding theme overrides
Currently, the documentation refers to creating new themes a lot.
It is much less apparent how one can customize an existing theme by
overriding individual templates or adding new ones. This commit adds
an FAQ for this, and also mentions the mechanism in the FAQ on custom
templates.
2024-10-10 14:35:07 +02:00
Noel Miller
84e31ba2b1 prepped for getpelican org 2024-10-08 16:28:15 -05:00
Noel Miller
403d50790b update github_pages.yml 2024-10-08 16:20:38 -05:00
Noel Miller
5ca672fe8b create build.yml 2024-10-08 16:19:56 -05:00
Justin Mayer
b02abf0220 Improve GitHub issue templates
Some checks failed
build / Test - 3.10 - macos (push) Has been cancelled
build / Test - 3.11 - macos (push) Has been cancelled
build / Test - 3.12 - macos (push) Has been cancelled
build / Test - 3.10 - ubuntu (push) Has been cancelled
build / Test - 3.11 - ubuntu (push) Has been cancelled
build / Test - 3.12 - ubuntu (push) Has been cancelled
build / Test - 3.8 - ubuntu (push) Has been cancelled
build / Test - 3.9 - ubuntu (push) Has been cancelled
build / Test - 3.10 - windows (push) Has been cancelled
build / Test - 3.11 - windows (push) Has been cancelled
build / Test - 3.12 - windows (push) Has been cancelled
build / Lint (push) Has been cancelled
build / Test build (push) Has been cancelled
build / Build docs (push) Has been cancelled
build / Deploy (push) Has been cancelled
2024-10-04 15:06:11 +02:00
Justin Mayer
f5dc4d4b96 Disable blank GitHub issues
Existing issue template categories should cover most any case.
2024-10-04 15:04:13 +02:00
Justin Mayer
478012e0d0 Clarify _include_path() parameter docstring 2024-10-02 19:08:26 +02:00
botpub
b86383fb28 Release Pelican 4.10.1 4.10.1 2024-09-28 17:02:04 +00:00
Justin Mayer
fe45094545 Prepare release 2024-09-28 18:59:03 +02:00
Frederik Elwert
08283b4915
Fix symbolic link handling in pelican-themes -s/-c (#3392) 2024-09-28 18:55:22 +02:00
Justin Mayer
0cb445c813
Don't store a RichHandler object in the argparse namespace (#3394) (#3398) 2024-09-28 18:50:54 +02:00
Clément Pit-Claudel
6c6b940ffc Don't store a RichHandler object in the argparse namespace (#3394) 2024-09-20 18:49:23 +02:00
Lioman
84db21c724
Match actual version instead of regex in build CI job (#3396) 2024-09-20 14:46:29 +02:00
Justin Mayer
2f9d382c56
Fix build job failure in GitHub CI workflow (#3395) 2024-09-20 14:35:07 +02:00
Lioman
86bf9230b4 test: fix build test
the regex, searching for the builded files was not stable to changes for two digit versions.

fixes: Build test failures in GitHub CI workflow #3393
2024-09-19 14:25:01 +02:00
botpub
a5db130e1d Release Pelican 4.10.0 4.10.0 2024-09-16 13:23:38 +00:00
Justin Mayer
9e8af627b5 Prepare release 2024-09-16 15:16:43 +02:00
Justin Mayer
44db258f59 Adjust list of Git-ignored files 2024-09-16 15:11:14 +02:00
GeorgeHu
e609b4d78a
Translate documentation into Simplified Chinese (#3346) 2024-09-15 14:29:01 +02:00
Egbert
5687883d4b
Bump Pygments to 2.16.1 in test requirements; fixes #3385 (#3386) 2024-09-12 14:21:12 +02:00
Justin Mayer
84f2995b38
Merge pull request #3387 from gagath/optimize-taskspy-template 2024-09-12 13:33:38 +02:00
GiovanH
4201256a5b
Add disabled status for #3304 (#3305) 2024-09-12 13:28:51 +02:00
Agathe Porte
2d375bc135 tasks.py.jinja2: optimize imports
When opening the generated tasks.py file with a Python linter enabled,
some imports will be marked as unecessary depending on the options
passed to pelican-quickstart.

Add if statements around the optional imports so they are used
only when necessary.
2024-08-04 22:39:50 +09:00
Justin Mayer
bb0ed26fdd Document how to have same source & output hierarchy 2024-07-30 10:00:36 +02:00
Justin Mayer
d85f493ee3 Add initial configuration for Vale prose linter
Vale: <https://github.com/errata-ai/vale>
2024-07-30 09:56:27 +02:00
Agathe
513abbfdc6
Introduce paragraph count summary (#2761)
Co-authored-by: Justin Mayer <entroP@gmail.com>
2024-06-25 15:07:41 +02:00
Justin Mayer
ef501a3d89
Merge pull request #3345 from getpelican/main-default-branch 2024-06-25 11:40:03 +02:00
Justin Mayer
36ebe91af7 Rename default branch to main 2024-06-25 11:33:28 +02:00
Justin Mayer
28e54106f2 Update Ruff linter 2024-06-25 11:00:41 +02:00
Justin Mayer
bdd4e45628 Enforce 75% code coverage in CI via Tox 2024-06-25 10:54:24 +02:00
Justin Mayer
6a50191728 Tweak Markdown-not-installed console warnings
Adding single-quotation marks should cause 'markdown' to be highlighted
in green, presumably via Rich.
2024-06-25 10:49:07 +02:00
Justin Mayer
f89f8894cc
Merge pull request #3321 from boxydog/warn_about_markdown 2024-06-25 10:10:34 +02:00
Justin Mayer
6fec5786d0
Merge pull request #3339 from tpwo/patch-1 2024-06-19 22:52:20 +02:00
Tomasz Wojdat
5171631dec
chore: update URLs of GitHub Ribbons
Old URLs are no longer active. New ones were taken from GitHub blog:
https://github.blog/2008-12-19-github-ribbons/

Also update output in functional tests.
2024-06-19 19:11:41 +02:00
Justin Mayer
8d63d1ced8
Merge pull request #3338 from getpelican/remove-sphinx-ifconfig 2024-06-18 09:27:03 +02:00
Justin Mayer
49723e6daf Docs: Remove ifconfig Sphinx extension
Originally added in #815, something about this seems to be causing an
obscure ReadTheDocs build error.
2024-06-18 09:08:45 +02:00
Justin Mayer
993c75103b Generate social cards in Sphinx documentation
Without `matplotlib` installed, Sphinx output says that social cards
cannot be generated.
2024-06-18 09:04:59 +02:00
Justin Mayer
7a2c72e604
Merge pull request #3337 from getpelican/document-feed-domain-optional 2024-06-17 22:22:59 +02:00
Justin Mayer
05535c7d6c Docs: GitHub Pages workflow is now supported 2024-06-17 22:19:21 +02:00
Sean Hammond
853e9e6b8a
Document that feed_domain is not required 2024-06-17 20:46:28 +01:00
dependabot[bot]
617aba077f Bump actions/setup-python from 4 to 5
Bumps [actions/setup-python](https://github.com/actions/setup-python) from 4 to 5.
- [Release notes](https://github.com/actions/setup-python/releases)
- [Commits](https://github.com/actions/setup-python/compare/v4...v5)

---
updated-dependencies:
- dependency-name: actions/setup-python
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-06-17 21:14:49 +02:00
dependabot[bot]
487877f206 Bump actions/deploy-pages from 2 to 4
Bumps [actions/deploy-pages](https://github.com/actions/deploy-pages) from 2 to 4.
- [Release notes](https://github.com/actions/deploy-pages/releases)
- [Commits](https://github.com/actions/deploy-pages/compare/v2...v4)

---
updated-dependencies:
- dependency-name: actions/deploy-pages
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-06-17 21:14:31 +02:00
dependabot[bot]
750a1f8bfa Bump actions/configure-pages from 3 to 5
Bumps [actions/configure-pages](https://github.com/actions/configure-pages) from 3 to 5.
- [Release notes](https://github.com/actions/configure-pages/releases)
- [Commits](https://github.com/actions/configure-pages/compare/v3...v5)

---
updated-dependencies:
- dependency-name: actions/configure-pages
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-06-17 21:14:18 +02:00
dependabot[bot]
d03ae2a41f Bump actions/upload-pages-artifact from 2 to 3
Bumps [actions/upload-pages-artifact](https://github.com/actions/upload-pages-artifact) from 2 to 3.
- [Release notes](https://github.com/actions/upload-pages-artifact/releases)
- [Commits](https://github.com/actions/upload-pages-artifact/compare/v2...v3)

---
updated-dependencies:
- dependency-name: actions/upload-pages-artifact
  dependency-type: direct:production
  update-type: version-update:semver-major
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-06-17 21:13:54 +02:00