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

update gallery for UnicodePlots #281

Merged
merged 6 commits into from
Apr 4, 2022
Merged

update gallery for UnicodePlots #281

merged 6 commits into from
Apr 4, 2022

Conversation

t-bltg
Copy link
Member

@t-bltg t-bltg commented Mar 23, 2022

@johnnychen94
Copy link
Contributor

It looks like the new release v1.27.2 does not trigger the documentation rebuild.

@t-bltg
Copy link
Member Author

t-bltg commented Mar 23, 2022

I have to merge JuliaPlots/UnicodePlots.jl#240 for this PR to work.

@johnnychen94
Copy link
Contributor

johnnychen94 commented Mar 23, 2022

Sorry, I meant https://docs.juliaplots.org/stable/ is still targeting v1.27.1 at the moment and I didn't see the docs CI run against v1.27.2 label in https://github.com/JuliaPlots/Plots.jl/actions/workflows/docs.yml. Any ideas?

@t-bltg
Copy link
Member Author

t-bltg commented Mar 23, 2022

Any ideas?

Oh yes, this is because https://github.com/JuliaPlots/Plots.jl/runs/5665604496?check_suite_focus=true has built the docs for JuliaPlots/Plots.jl@0686461, which was before I bumped the Plots.jl version to 1.27.2 in JuliaPlots/Plots.jl@bcc66ca (which skipped ci and thus building the docs).

So any commit to master will now build the docs for 1.27.2.

I would also like to remove the docs pages for the old versions (1.25, 1.26, ...) (per #270).

@BeastyBlacksmith
Copy link
Member

BeastyBlacksmith commented Mar 24, 2022

So any commit to master will now build the docs for 1.27.2.

Without tag they only build for dev. You can trigger the build manually on the actions tab (which I did now) or you don't put [skip ci] on the commit message that gets the tag.

@johnnychen94
Copy link
Contributor

I see you need JuliaDocs/DemoCards.jl#109 for debug purposes. How about committing docs/Manifest.toml file with the dev-ed version of that branch via git add -f docs/Manifest.toml? When everything works fine we can safely delete the Manifest file.

For local development, you can first run generate_cards(:unicodeplots) to generate the files, and then use DemoCards.preview_demos("docs/src/gallery/unicodeplots") for fast preview.

@t-bltg
Copy link
Member Author

t-bltg commented Mar 24, 2022

How about committing docs/Manifest.toml file with the dev-ed version of that branch via git add -f docs/Manifest.toml? When everything works fine we can safely delete the Manifest file.

I don't understand this. I work locally and I don't have any Manifest file here.

For local development

I am sticking with the docs.yml command: JULIA_DEBUG=Documenter,DemoCards GITLAB_CI=true GKSwstype=nul julia --project=docs/ docs/make.jl

@johnnychen94
Copy link
Contributor

johnnychen94 commented Mar 24, 2022

(docs) pkg> add https://github.com/t-bltg/DemoCards.jl.git#debug
     Cloning git-repo `https://github.com/t-bltg/DemoCards.jl.git`
    Updating git-repo `https://github.com/t-bltg/DemoCards.jl.git`
    Updating registry at `~/.julia/registries/General.toml`
...

shell> git add docs/Manifest.toml -f

shell> git status
Refresh index: 100% (249/249), done.
On branch master
Your branch is up to date with 'origin/master'.

Changes to be committed:
  (use "git restore --staged <file>..." to unstage)
        new file:   docs/Manifest.toml
...

shell> git commit -m "debug: temporarly commit docs/Manifest.toml"
[master c22be33] debug: temporarly commit docs/Manifest.toml
 1 file changed, 645 insertions(+)
 create mode 100644 docs/Manifest.toml

By force committing docs/Manifest.toml file, the instantiate() command in

xvfb-run julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()));
Pkg.instantiate()'
will use that specific DemoCards.jl branch and build the documentation. When everything works fine, we can then delete this debug file.

@t-bltg t-bltg changed the title update gallery for unicodeplots update gallery for UnicodePlots Apr 4, 2022
@t-bltg
Copy link
Member Author

t-bltg commented Apr 4, 2022

CI passes, let's merge this now and see how it renders.

@t-bltg t-bltg merged commit b847f29 into JuliaPlots:master Apr 4, 2022
@t-bltg t-bltg deleted the up branch April 4, 2022 18:05
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