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

add ability to add contributor information to html pages (#1254) #1299

Merged
merged 19 commits into from
Jun 26, 2023

Conversation

RussBerg
Copy link
Contributor

@RussBerg RussBerg commented Jun 21, 2023

Ok I finally have all the code changes made to accomplish what was talked about,
The contributors are listed left to right most recent to oldest, mouse over gives name and date of last commit and clicking avatar takes you to that persons github profile.

Also added is the link to create a new github issue in the get help link.

Image

A github access token is required to retrieve the contributor information from the github API and this token is passed in the environment variable GH_TOKEN. During the codecamp @mkuehbach sent me an example of how they do it in fairmat https://github.com/FAIRmat-NFDI/nexus-fairmat-proposal/blob/main/.github/workflows/update-proposal-webpage.yml

So it looks like what we need can be achieved in jenkins by wrapping the line:

( cd ../impatient-guide && rm -rf _build && make latexpdf && make html )

like this?

withEnv(['GH_TOKEN=secrets.GITHUB_TOKEN']) {
         // Then call to build docs
         ( cd ../impatient-guide && rm -rf _build && make latexpdf && make html )
       
     }

please @prjemian could you check me on this
closes #1254

@RussBerg RussBerg requested a review from prjemian June 21, 2023 20:10
@RussBerg RussBerg marked this pull request as draft June 21, 2023 20:10
@prjemian prjemian requested review from a team and removed request for prjemian June 21, 2023 20:37
@prjemian
Copy link
Contributor

@RussBerg Sorry, I won't have time to review in the next day or so. Perhaps someone else can review? I re-assigned to the NeXus developers

Copy link
Contributor

@PeterC-DLS PeterC-DLS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Run the black formatter

dev_tools/docs/nxdl.py Outdated Show resolved Hide resolved
dev_tools/docs/nxdl.py Outdated Show resolved Hide resolved
dev_tools/ext/contrib_ext.py Outdated Show resolved Hide resolved
dev_tools/utils/github.py Outdated Show resolved Hide resolved
dev_tools/utils/github.py Outdated Show resolved Hide resolved
dev_tools/utils/github.py Outdated Show resolved Hide resolved
dev_tools/utils/github.py Show resolved Hide resolved
dev_tools/utils/github.py Outdated Show resolved Hide resolved
manual/source/_templates/sourcelink.html Outdated Show resolved Hide resolved
manual/source/_templates/sourcelink.html Outdated Show resolved Hide resolved
@RussBerg
Copy link
Contributor Author

@PeterC-DLS are you familiar with the jenkins stuff to hazard a guess on how to pull the github access token from "secrets" and add it to the environment?

@PeterC-DLS
Copy link
Contributor

Yes, I can adjust the workflow to populate the environment running the build with the token. Note, the CI is failing as there are files not formatted correctly.

@PeterC-DLS
Copy link
Contributor

See this change

env:
GH_TOKEN: ${{secrets.GITHUB_TOKEN}}
and add it to

@PeterC-DLS PeterC-DLS closed this Jun 22, 2023
@PeterC-DLS PeterC-DLS reopened this Jun 22, 2023
@PeterC-DLS
Copy link
Contributor

Sorry, I clicked the wrong button!

@RussBerg RussBerg marked this pull request as ready for review June 22, 2023 23:01
@RussBerg RussBerg requested a review from PeterC-DLS June 22, 2023 23:01
@RussBerg RussBerg marked this pull request as draft June 22, 2023 23:09
@RussBerg RussBerg marked this pull request as ready for review June 23, 2023 00:17
@RussBerg RussBerg marked this pull request as draft June 23, 2023 16:51
@PeterC-DLS PeterC-DLS mentioned this pull request Jun 23, 2023
@PeterC-DLS
Copy link
Contributor

Does the CI GH token allow access to GH's REST API? If not, I could set an specific access token for this purpose

@RussBerg
Copy link
Contributor Author

RussBerg commented Jun 23, 2023

yes the url that I am passing the token to in github.py uses the REST API endpoint

@RussBerg RussBerg marked this pull request as ready for review June 23, 2023 19:02
Copy link
Contributor

@PeterC-DLS PeterC-DLS left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@RussBerg RussBerg merged commit 747d240 into main Jun 26, 2023
4 checks passed
@RussBerg RussBerg deleted the 1254-add-list-of-contributors-to-appdef branch June 26, 2023 14:31
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Development

Successfully merging this pull request may close these issues.

Make list of maintainers for application definitions
3 participants