Skip to content

Commit

Permalink
ENH Update reference to supported modules data (#136)
Browse files Browse the repository at this point in the history
  • Loading branch information
GuySartorelli authored May 9, 2024
1 parent 293fb07 commit 9583427
Show file tree
Hide file tree
Showing 8 changed files with 118 additions and 122 deletions.
10 changes: 6 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@

This app uses the Github issue search API to provide
a convenient issue browser across all of our
[supported modules](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/).
[supported modules](https://docs.silverstripe.org/en/project_governance/supported_modules/)
as well as other repositories that are important for maintenance.

It uses [vue-cli](https://github.com/vuejs/vue-cli/blob/dev/docs/cli.md)
to simplify local development and production builds for VueJS.
Expand All @@ -15,6 +16,7 @@ You can use it on https://github-issue-search-client-silverstripe.vercel.app.
This project is powered by [Vercel](https://vercel.com/?utm_source=silverstripe&utm_campaign=oss).

![Vercel logo](_img/vercel-logotype-dark.png)

## Install

Use Node v8 or higher.
Expand All @@ -39,10 +41,10 @@ Note that the token should NOT have any other permissions/scopes, since it will
in the client bundle (and is readable by everyone through network requests).
The only reason to include it here is avoiding to hit Github's rate limits without it.

In order to get an updated list of our [supported modules](https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/),
In order to get an updated list of the repositories we care about,
you can run the following command. This will be written to the `repos.json` file in the `src` folder, which can be
updated (in VCS) periodically if required. This will also happen during a deployment and auto-update in the
Now environment.
updated (in VCS) periodically if required.
This gets run during a deployment and auto-update in the Vercel environment.

```bash
npm run get-repos
Expand Down
3 changes: 3 additions & 0 deletions src/components/ApolloResults.vue
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,9 @@ export default defineComponent({
if (this.formData.includeSupported) {
ids.push('supported');
}
if (this.formData.includeOther) {
ids.push('other');
}
let repos = this.formData.customRepos.length ?
// Pass in custom list of repos through the URL.
Expand Down
6 changes: 6 additions & 0 deletions src/components/RestResults.vue
Original file line number Diff line number Diff line change
Expand Up @@ -86,6 +86,9 @@ export default defineComponent({
if (this.formData.includeSupported) {
ids.push('supported');
}
if (this.formData.includeOther) {
ids.push('other');
}
const repos = this.formData.customRepos.length ?
// Pass in custom list of repos through the URL.
Expand All @@ -112,6 +115,9 @@ export default defineComponent({
if (this.formData.includeSupported) {
ids.push('supported');
}
if (this.formData.includeOther) {
ids.push('other');
}
const repos = this.formData.customRepos.length ?
// Pass in custom list of repos through the URL.
Expand Down
10 changes: 8 additions & 2 deletions src/components/SearchForm.vue
Original file line number Diff line number Diff line change
Expand Up @@ -13,10 +13,16 @@
<span class="option-filter" v-if="data.customRepos.length">
Filtering by {{data.customRepos.length}} repos
</span>
<label class="option-filter" v-else>
<label class="option-filter" v-if="!data.customRepos.length">
<input type="checkbox" id="supported-modules" v-model="data.includeSupported" @change="doSearch()" />
<span>
Include <a href="https://www.silverstripe.org/software/addons/silverstripe-commercially-supported-module-list/" target="_blank" rel="noopener">supported modules</a>
Include <a href="https://docs.silverstripe.org/en/project_governance/supported_modules/" target="_blank" rel="noopener">supported modules</a>
</span>
</label>
<label class="option-filter" v-if="!data.customRepos.length">
<input type="checkbox" id="other-repos" v-model="data.includeOther" @change="doSearch()" />
<span>
Include maintenance repos
</span>
</label>

Expand Down
3 changes: 3 additions & 0 deletions src/components/SearchResults.vue
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ export default defineComponent({
mode: '',
customRepos: [],
includeSupported: true,
includeOther: true,
communityOnly: false,
issueStatus: 'open',
issueType: 'issue',
Expand All @@ -40,6 +41,7 @@ export default defineComponent({
mode: searchParams.get('mode') || defaults.mode,
customRepos: searchParams.get('customRepos') ? searchParams.get('customRepos').split(',') : defaults.customRepos,
includeSupported: searchParams.get('includeSupported') !== '0',
includeOther: searchParams.get('includeOther') !== '0',
communityOnly: Boolean(searchParams.get('communityOnly')),
issueStatus: searchParams.get('issueStatus') || defaults.issueStatus,
issueType: searchParams.get('issueType') || defaults.issueType,
Expand Down Expand Up @@ -67,6 +69,7 @@ export default defineComponent({
mode: formData.mode || '',
customRepos: formData.customRepos ? formData.customRepos : [],
includeSupported: formData.includeSupported,
includeOther: formData.includeOther,
communityOnly: formData.communityOnly,
issueStatus: formData.issueStatus || 'open',
issueType: formData.issueType,
Expand Down
118 changes: 66 additions & 52 deletions src/repos.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,42 +23,34 @@
"silverstripe/vendor-plugin",
"silverstripe/silverstripe-versioned",
"silverstripe/silverstripe-versioned-admin",
"silverstripe-themes/silverstripe-simple"
"silverstripe/silverstripe-simple"
]
},
{
"id": "supported",
"name": "Supported",
"repos": [
"silverstripe/gha-action-ci",
"silverstripe/gha-auto-tag",
"silverstripe/gha-ci",
"silverstripe/gha-dispatch-ci",
"silverstripe/gha-gauge-release",
"silverstripe/gha-generate-matrix",
"silverstripe/gha-issue",
"silverstripe/gha-keepalive",
"silverstripe/gha-merge-up",
"silverstripe/gha-pull-request",
"silverstripe/gha-run-tests",
"silverstripe/gha-tag-release",
"silverstripe/gha-trigger-ci",
"silverstripe/gha-update-js",
"silverstripe/cow",
"silverstripe/rhino",
"silverstripe/github-issue-search-client",
"silverstripe/module-standardiser",
"silverstripe/silverstripe-tx-translator",
"silverstripe/markdown-php-codesniffer",
"silverstripe/.github",
"silverstripe/eslint-config",
"silverstripe/webpack-config",
"silverstripe/silverstripe-module",
"silverstripe/api.silverstripe.org",
"silverstripe/doc.silverstripe.org",
"silverstripe/silverstripe-userhelp-content",
"silverstripe/demo.silverstripe.org",
"silverstripe/silverstripe-frameworktest",
"silverstripe/developer-docs",
"silverstripe/silverstripe-admin",
"silverstripe/silverstripe-asset-admin",
"silverstripe/silverstripe-assets",
"silverstripe/silverstripe-campaign-admin",
"silverstripe/silverstripe-cms",
"silverstripe/silverstripe-config",
"silverstripe/silverstripe-errorpage",
"silverstripe/silverstripe-framework",
"silverstripe/silverstripe-graphql",
"silverstripe/silverstripe-installer",
"silverstripe/silverstripe-session-manager",
"silverstripe/recipe-cms",
"silverstripe/recipe-core",
"silverstripe/recipe-plugin",
"silverstripe/silverstripe-reports",
"silverstripe/silverstripe-siteconfig",
"silverstripe/vendor-plugin",
"silverstripe/silverstripe-versioned",
"silverstripe/silverstripe-versioned-admin",
"silverstripe/silverstripe-simple",
"bringyourownideas/silverstripe-maintenance",
"bringyourownideas/silverstripe-composer-update-checker",
"bringyourownideas/silverstripe-composer-security-checker",
Expand All @@ -70,84 +62,65 @@
"silverstripe/cwp-search",
"silverstripe/cwp-starter-theme",
"silverstripe/cwp-watea-theme",
"silverstripe/developer-docs",
"silverstripe/silverstripe-elemental",
"dnadesign/silverstripe-elemental-subsites",
"dnadesign/silverstripe-elemental-userforms",
"hafriedlander/silverstripe-phockito",
"lekoala/silverstripe-debugbar",
"silverstripe/silverstripe-admin",
"silverstripe/silverstripe-akismet",
"silverstripe/silverstripe-asset-admin",
"silverstripe/silverstripe-assets",
"silverstripe/silverstripe-auditor",
"silverstripe/silverstripe-behat-extension",
"silverstripe/silverstripe-blog",
"silverstripe/silverstripe-campaign-admin",
"silverstripe/silverstripe-ckan-registry",
"silverstripe/silverstripe-cms",
"silverstripe/comment-notifications",
"silverstripe/silverstripe-comments",
"silverstripe/silverstripe-config",
"silverstripe/silverstripe-content-widget",
"silverstripe/silverstripe-contentreview",
"silverstripe/silverstripe-crontask",
"silverstripe/silverstripe-documentconverter",
"silverstripe/silverstripe-elemental-bannerblock",
"silverstripe/silverstripe-elemental-fileblock",
"silverstripe/silverstripe-environmentcheck",
"silverstripe/silverstripe-errorpage",
"silverstripe/silverstripe-externallinks",
"silverstripe/silverstripe-framework",
"silverstripe/silverstripe-fulltextsearch",
"silverstripe/silverstripe-graphql",
"silverstripe/silverstripe-graphql-devtools",
"silverstripe/silverstripe-gridfieldqueuedexport",
"silverstripe/silverstripe-html5",
"silverstripe/silverstripe-hybridsessions",
"silverstripe/silverstripe-iframe",
"silverstripe/silverstripe-installer",
"silverstripe/silverstripe-ldap",
"silverstripe/silverstripe-linkfield",
"silverstripe/silverstripe-lumberjack",
"silverstripe/silverstripe-mimevalidator",
"silverstripe/silverstripe-postgresql",
"silverstripe/silverstripe-realme",
"silverstripe/silverstripe-session-manager",
"silverstripe/recipe-authoring-tools",
"silverstripe/recipe-blog",
"silverstripe/recipe-ccl",
"silverstripe/recipe-cms",
"silverstripe/recipe-collaboration",
"silverstripe/recipe-content-blocks",
"silverstripe/recipe-core",
"silverstripe/recipe-form-building",
"silverstripe/recipe-plugin",
"silverstripe/recipe-reporting-tools",
"silverstripe/recipe-services",
"silverstripe/recipe-solr-search",
"silverstripe/recipe-kitchen-sink",
"silverstripe/silverstripe-registry",
"silverstripe/silverstripe-reports",
"silverstripe/silverstripe-restfulserver",
"silverstripe/silverstripe-securityreport",
"silverstripe/silverstripe-segment-field",
"silverstripe/silverstripe-sharedraftcontent",
"silverstripe/silverstripe-siteconfig",
"silverstripe/silverstripe-sitewidecontent-report",
"silverstripe/silverstripe-spamprotection",
"silverstripe/silverstripe-spellcheck",
"silverstripe/silverstripe-sqlite3",
"silverstripe/sspak",
"silverstripe/silverstripe-staticpublishqueue",
"silverstripe/silverstripe-subsites",
"silverstripe/silverstripe-tagfield",
"silverstripe/silverstripe-taxonomy",
"silverstripe/silverstripe-textextraction",
"silverstripe/silverstripe-userforms",
"silverstripe/vendor-plugin",
"silverstripe/silverstripe-versioned",
"silverstripe/silverstripe-versioned-admin",
"silverstripe/silverstripe-versionfeed",
"silverstripe/silverstripe-widgets",
"silverstripe-themes/silverstripe-simple",
"symbiote/silverstripe-advancedworkflow",
"symbiote/silverstripe-gridfieldextensions",
"symbiote/silverstripe-multivaluefield",
Expand All @@ -161,5 +134,46 @@
"silverstripe/silverstripe-security-extensions",
"silverstripe/silverstripe-dynamodb"
]
},
{
"id": "other",
"name": "Other",
"repos": [
"silverstripe/gha-action-ci",
"silverstripe/gha-auto-tag",
"silverstripe/gha-ci",
"silverstripe/gha-dispatch-ci",
"silverstripe/gha-gauge-release",
"silverstripe/gha-generate-matrix",
"silverstripe/gha-issue",
"silverstripe/gha-keepalive",
"silverstripe/gha-merge-up",
"silverstripe/gha-pull-request",
"silverstripe/gha-run-tests",
"silverstripe/gha-tag-release",
"silverstripe/gha-trigger-ci",
"silverstripe/gha-update-js",
"silverstripe/recipe-testing",
"silverstripe/silverstripe-behat-extension",
"silverstripe/MinkFacebookWebDriver",
"silverstripe/cow",
"silverstripe/rhino",
"silverstripe/github-issue-search-client",
"silverstripe/module-standardiser",
"silverstripe/silverstripe-tx-translator",
"silverstripe/markdown-php-codesniffer",
"silverstripe/silverstripe-standards",
"silverstripe/documentation-lint",
"silverstripe/supported-modules",
"silverstripe/eslint-config",
"silverstripe/webpack-config",
"silverstripe/.github",
"silverstripe/api.silverstripe.org",
"silverstripe/doc.silverstripe.org",
"silverstripe/silverstripe-userhelp-content",
"silverstripe/demo.silverstripe.org",
"silverstripe/silverstripe-frameworktest",
"silverstripe/silverstripe-module"
]
}
]
1 change: 1 addition & 0 deletions src/types.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ export type FormData = {
mode: Mode,
customRepos: string[],
includeSupported: boolean,
includeOther: boolean,
communityOnly: boolean,
issueStatus: IssueStatus,
issueType: IssueType,
Expand Down
Loading

0 comments on commit 9583427

Please sign in to comment.