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

Configure statusboard #1

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Configure statusboard #1

wants to merge 1 commit into from

Conversation

wesleytodd
Copy link
Member

@wesleytodd wesleytodd commented Aug 15, 2019

Setting up the integration of @pkgjs/statusboard. More to come.

This is the start, but there is much more work to do: https://expressjs.github.io/statusboard

@wesleytodd
Copy link
Member Author

@andrewhughes101 @jonchurch Looks good right?

https://expressjs.github.io/statusboard/

@jonchurch
Copy link
Member

jonchurch commented Apr 22, 2020

Seems to be working 🎉

Do you want reviews on this PR yet or is it still a WIP?

I was going to ask about the pull_request trigger in the workflow (is it just for testing atm? It will update gh-pages whenever a new PR is opened), and testing it with fetching by org instead of individual projects.

@wesleytodd
Copy link
Member Author

Yeah specific review here would be good. Now that you mention that I am digging though this and it is sloppy. I think you are right that I added that for testing so that needs to be removed. I can look at that today, but any review you have would be valuable so I can merge it right after doing the cleanup.

Comment on lines +24 to +71
projects: [
'expressjs/express',
'expressjs/discussions',
'expressjs/cors',
'expressjs/morgan',
'expressjs/response-time',
'expressjs/session',
'expressjs/multer',
'expressjs/body-parser',
'expressjs/compression',
'expressjs/serve-static',
'expressjs/errorhandler',
'expressjs/serve-index',
'expressjs/csurf',
'expressjs/timeout',
'expressjs/flash',
'expressjs/vhost',

'pillarjs/router',
'pillarjs/cookies',
'pillarjs/send',
'pillarjs/finalhandler',
'pillarjs/path-to-regexp',

'jshttp/cookie',
'jshttp/fresh',
'jshttp/content-disposition',
'jshttp/mime-db',
'jshttp/media-typer',
'jshttp/range-parser',
'jshttp/type-is',
'jshttp/accepts',
'jshttp/negotiator',
'jshttp/mime-types',
'jshttp/compressible',
'jshttp/content-type',
'jshttp/http-errors',
'jshttp/proxy-addr',
'jshttp/etag',
'jshttp/forwarded',
'jshttp/on-finished',
'jshttp/on-headers',
'jshttp/vary',
'jshttp/basic-auth',
'jshttp/methods',
'jshttp/statuses'
],

Copy link
Member

@jonchurch jonchurch Apr 24, 2020

Choose a reason for hiding this comment

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

Suggested change
projects: [
'expressjs/express',
'expressjs/discussions',
'expressjs/cors',
'expressjs/morgan',
'expressjs/response-time',
'expressjs/session',
'expressjs/multer',
'expressjs/body-parser',
'expressjs/compression',
'expressjs/serve-static',
'expressjs/errorhandler',
'expressjs/serve-index',
'expressjs/csurf',
'expressjs/timeout',
'expressjs/flash',
'expressjs/vhost',
'pillarjs/router',
'pillarjs/cookies',
'pillarjs/send',
'pillarjs/finalhandler',
'pillarjs/path-to-regexp',
'jshttp/cookie',
'jshttp/fresh',
'jshttp/content-disposition',
'jshttp/mime-db',
'jshttp/media-typer',
'jshttp/range-parser',
'jshttp/type-is',
'jshttp/accepts',
'jshttp/negotiator',
'jshttp/mime-types',
'jshttp/compressible',
'jshttp/content-type',
'jshttp/http-errors',
'jshttp/proxy-addr',
'jshttp/etag',
'jshttp/forwarded',
'jshttp/on-finished',
'jshttp/on-headers',
'jshttp/vary',
'jshttp/basic-auth',
'jshttp/methods',
'jshttp/statuses'
],
projects: [],
orgs: [
"jshttp",
"pillarjs",
"expressjs"
]

My preference is to do this by orgs

Copy link
Member Author

Choose a reason for hiding this comment

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

So I dropped some from the list which are unmaintained or deprecated. We talked about moving them out of the orgs, but haven't yet. I do agree if we get those cleaned up it would be better to do what you are saying.

Choose a reason for hiding this comment

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

I did move a couple more out recently (I think 2 months ago) but we do need to go through them. Those repos wouldn't really contribute anything to the stats, though. Is not listing them just to like make the loading process faster?

Copy link
Member Author

Choose a reason for hiding this comment

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

Not listing them was mainly so users or triagers did not spend time on them. But if we think everything remaining in the repo is good, then the next step would be to add support for specifying orgs and pulling a list of repos to populate data from. This is not supported today in @pkgjs/statusboard, but should be IMO.

on:
pull_request:
branches:
- master
Copy link
Member Author

Choose a reason for hiding this comment

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

This is the part we should remove.

git config user.email "<>"
git config user.name "${GITHUB_ACTOR}"
- name: Setup gh-pages branch
run: |
Copy link
Member Author

Choose a reason for hiding this comment

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

This whole part should be replaced with https://github.com/pkgjs/gh-pages/

That is the whole reason I made that action in the first place.

@@ -0,0 +1,32 @@
name: Publish GPR Package
Copy link
Member Author

Choose a reason for hiding this comment

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

I think we should just remove this. This was me testing what this would look like as a published package. I am not sure there is value in this.

Choose a reason for hiding this comment

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

Makes sense. I was curious what the package was for.

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah, it was a bit weird, but I was publishing the entire dataset as a package where the wrapper around @pkgjs/statusboard was the interface. I guess my thought was that something in theory could consume the statusboard data from multiple communities and pull them together. For example if the OpenJS Foundation wanted to have a board with all the project activity together, they could import all of the individual projects and build a view from that. I still think it is an interesting idea, but of little value to us today.

Choose a reason for hiding this comment

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

Ah. That is an interesting idea, though, especially with the amount of time it takes to generate the data just for our repos, it would make sense to have a static copy to build off of. But yea, agree no use to us currently. But fun to experiment with the package publishing I'm sure 😄

Copy link
Member Author

@wesleytodd wesleytodd Apr 29, 2020

Choose a reason for hiding this comment

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

it would make sense to have a static copy to build off of

Yeah that is what the published package is. It is literally the leveldb database 🤪

EDIT: Well I think it is. That is what I intended to do and I cant remember now if that is what I actually did. Again, doesn't matter since it is unnecessary.

'jshttp/statuses'
],

teams: {
Copy link
Member Author

Choose a reason for hiding this comment

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

All of this is also not used currently by the status board. But my intent was to use this to display an updated list of members. Now that I look at it, it would be better to have the status board pull the list of teams from GitHub, not the other way around.

Copy link
Member

@jonchurch jonchurch left a comment

Choose a reason for hiding this comment

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

I think it's good to go, just suggested removing vestigial parts

Comment on lines +4 to +6
pull_request:
branches:
- master
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
pull_request:
branches:
- master

Comment on lines +1 to +32
name: Publish GPR Package

on:
push:
branches:
- master

jobs:
publish-gpr:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Setup git user
run: |
git config user.email "<>"
git config user.name "${GITHUB_ACTOR}"
- uses: actions/setup-node@v1
with:
node-version: 12
registry-url: https://npm.pkg.github.com/
scope: '@expressjs'
- name: NPM Install
run: npm i
- name: NPM Version
run: npm version prerelease --preid="${GITHUB_SHA}"
- name: NPM Publish
run: npm publish
env:
NODE_AUTH_TOKEN: ${{secrets.GH_TOKEN}}
- name: Push version and tag
run: |
git push https://wesleytodd:${{secrets.GH_TOKEN}}@github.com/${GITHUB_REPOSITORY}.git --tags
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
name: Publish GPR Package
on:
push:
branches:
- master
jobs:
publish-gpr:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v1
- name: Setup git user
run: |
git config user.email "<>"
git config user.name "${GITHUB_ACTOR}"
- uses: actions/setup-node@v1
with:
node-version: 12
registry-url: https://npm.pkg.github.com/
scope: '@expressjs'
- name: NPM Install
run: npm i
- name: NPM Version
run: npm version prerelease --preid="${GITHUB_SHA}"
- name: NPM Publish
run: npm publish
env:
NODE_AUTH_TOKEN: ${{secrets.GH_TOKEN}}
- name: Push version and tag
run: |
git push https://wesleytodd:${{secrets.GH_TOKEN}}@github.com/${GITHUB_REPOSITORY}.git --tags

Comment on lines +72 to +111
teams: {
technicalCommitee: [{
name: 'Doug Wilson',
github: 'dougwilson',
npm: 'dougwilson',
twitter: 'blipsofadoug',
email: '[email protected]'
}, {
name: 'Jonathan Ong',
github: 'jonathanong',
npm: 'jongleberry',
twitter: 'jongleberry',
email: '[email protected]',
avatar: '6e33cc0412b61cc01daac23c8989003c'
}, {
name: 'Jeremiah Senkpiel',
github: 'fishrock123',
npm: 'fishrock123',
twitter: 'fishrock123',
email: '[email protected]'
}, {
name: 'Alex Kocharin',
github: 'rlidwka',
npm: 'rlidwka',
twitter: 'rlidwka',
email: '[email protected]'
}, {
name: 'Linus Unnebäck',
github: 'LinusU',
npm: 'linusu',
twitter: 'LinusU',
email: '[email protected]'
}, {
name: 'Wes Todd',
github: 'wesleytodd',
npm: 'wesleytodd',
twitter: 'wesleytodd',
email: '[email protected]'
}]
}
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
teams: {
technicalCommitee: [{
name: 'Doug Wilson',
github: 'dougwilson',
npm: 'dougwilson',
twitter: 'blipsofadoug',
email: '[email protected]'
}, {
name: 'Jonathan Ong',
github: 'jonathanong',
npm: 'jongleberry',
twitter: 'jongleberry',
email: '[email protected]',
avatar: '6e33cc0412b61cc01daac23c8989003c'
}, {
name: 'Jeremiah Senkpiel',
github: 'fishrock123',
npm: 'fishrock123',
twitter: 'fishrock123',
email: '[email protected]'
}, {
name: 'Alex Kocharin',
github: 'rlidwka',
npm: 'rlidwka',
twitter: 'rlidwka',
email: '[email protected]'
}, {
name: 'Linus Unnebäck',
github: 'LinusU',
npm: 'linusu',
twitter: 'LinusU',
email: '[email protected]'
}, {
name: 'Wes Todd',
github: 'wesleytodd',
npm: 'wesleytodd',
twitter: 'wesleytodd',
email: '[email protected]'
}]
}

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.

3 participants