Skip to content

Stage site on GH actions#489

Merged
slawekjaranowski merged 1 commit intoapache:masterfrom
slawekjaranowski:site-stage
Mar 16, 2022
Merged

Stage site on GH actions#489
slawekjaranowski merged 1 commit intoapache:masterfrom
slawekjaranowski:site-stage

Conversation

@slawekjaranowski
Copy link
Copy Markdown
Member

According to apache/maven-gh-actions-shared#40


Following this checklist to help us incorporate your
contribution quickly and easily:

  • Make sure there is a JIRA issue filed
    for the change (usually before you start working on it). Trivial changes like typos do not
    require a JIRA issue. Your pull request should address just this issue, without
    pulling in other changes.
  • Each commit in the pull request should have a meaningful subject line and body.
  • Format the pull request title like [SUREFIRE-XXX] - Fixes bug in ApproximateQuantiles,
    where you replace SUREFIRE-XXX with the appropriate JIRA issue. Best practice
    is to use the JIRA issue title in the pull request title and in the first line of the
    commit message.
  • Write a pull request description that is detailed enough to understand what the pull request does, how, and why.
  • Run mvn clean install to make sure basic checks pass. A more thorough check will
    be performed on your pull request automatically.
  • You have run the integration tests successfully (mvn -Prun-its clean install).

If your pull request is about ~20 lines of code you don't need to sign an
Individual Contributor License Agreement if you are unsure
please ask on the developers list.

To make clear that you license your contribution under
the Apache License Version 2.0, January 2004
you have to acknowledge this by using the following check-box.

@Tibor17
Copy link
Copy Markdown
Contributor

Tibor17 commented Mar 16, 2022

@slawekjaranowski
I understand site:stage but I want to ask you what benefit I should have.
It would be great to see the HTML web content in GH project and check or fix the Apt files if I see wrong headers or so. Would it be possible to do?

@slawekjaranowski
Copy link
Copy Markdown
Member Author

@Tibor17
Content of target/stage is uploaded as GH artifact ... please look at action result for this PR, there is:
588-site-ubuntu-latest-18-ea-temurin

@Tibor17
Copy link
Copy Markdown
Contributor

Tibor17 commented Mar 16, 2022

@slawekjaranowski
I understand that zipping the web content is the first try which requires some extra work to check it.
There is one more comfortable way with an example as follows.
We talked about it in the mailing list that there is Github support with gh-pages, example:

    # Push the book's HTML to github-pages
    - name: GitHub Pages action
      uses: peaceiris/actions-gh-pages@v3.6.1
      with:
        github_token: ${{ secrets.GITHUB_TOKEN }}
        publish_dir: ./_build/html

References:
https://jupyterbook.org/publish/gh-pages.html
https://stackoverflow.com/questions/8446218/how-to-see-an-html-page-on-github-as-a-normal-rendered-html-page-to-see-preview
Can you pls make a draft with GH pages?
I will appove this PR.

@slawekjaranowski
Copy link
Copy Markdown
Member Author

GITHUB_TOKEN for PR build from fork has read-only access so will be not possible to store something in repo.

Additionally we should manage many pages for master and each PR in separate space, cleanup outdated etc ... it is too complicated.

I hope that current solution is good enough.

@slawekjaranowski slawekjaranowski merged commit 722fa93 into apache:master Mar 16, 2022
@slawekjaranowski slawekjaranowski deleted the site-stage branch March 16, 2022 15:23
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.

2 participants