FOLIO Backend module for Serials Management
", + "snippetIntro": "mod-serials-management is a FOLIO module to support serials management functionality. Specifically this includes managing serial records which support a status and description, can be linked to a purchase order line and title from mod-orders and can have a publication pattern defined.
", "workflows": [ + "api-doc.yml", + "api-lint.yml", + "api-schema-lint.yml", "gradle.yml" + ], + "workflowsFolio": [ + "api-doc.yml", + "api-lint.yml", + "api-schema-lint.yml" ] }, { diff --git a/_faqs/how-to-request-github-access.md b/_faqs/how-to-request-github-access.md index 9c5a7e82..36f748dc 100644 --- a/_faqs/how-to-request-github-access.md +++ b/_faqs/how-to-request-github-access.md @@ -9,7 +9,7 @@ faqOrder: 2 ## GitHub new developer -For new developers (i.e. not yet a [member](https://github.com/orgs/folio-org/people) of "folio-org" organization) we ask that a project manager (see [Team and module responsibility matrix](https://wiki.folio.org/pages/viewpage.action?pageId=14463134)) or at least a known existing developer, makes this request. +For new developers (i.e. not yet a [member](https://github.com/orgs/folio-org/people) of "folio-org" organization) we ask that a project manager (see [Team and module responsibility matrix](https://folio-org.atlassian.net/wiki/x/plAV)) or at least a known existing developer, makes this request. They need to either request on the #devops Slack channel, or [raise a FOLIO DevOps Jira ticket](/faqs/how-to-raise-devops-ticket/#general-folio-devops). Especially do the latter with a group of new people. diff --git a/community/index.md b/community/index.md index d135d924..2c24f8b9 100644 --- a/community/index.md +++ b/community/index.md @@ -98,7 +98,7 @@ Since [commencing](/about/) in mid-2016 the FOLIO project continues to grow. Some contact points for the communities: * [Collaboration tools](#collaboration-tools). -* [Team and module responsibility matrix](https://wiki.folio.org/pages/viewpage.action?pageId=14463134). +* [Team and module responsibility matrix](https://folio-org.atlassian.net/wiki/x/plAV). * [List of GitHub Teams](https://github.com/orgs/folio-org/teams). * [Development teams wiki space](https://wiki.folio.org/display/FOLIJET/). * [Testing Community wiki space](https://wiki.folio.org/display/FTC/Folio+Testing+Community+Home). diff --git a/guidelines/create-new-repo.md b/guidelines/create-new-repo.md index 3a23f8dd..a8d9f608 100644 --- a/guidelines/create-new-repo.md +++ b/guidelines/create-new-repo.md @@ -43,6 +43,7 @@ Add a concise "About" description to the GitHub repository. Consider that this w (If the "Edit" button is not available to you, then see the "support" advice above.) Note: The configuration of "branch protection" and its "required checks" can only be done after there has been an initial pull-request (and must be done within one week of its opening). +Also, for [front-end](#add-specific-configuration-files) repositories, the GitHub Actions Workflows need to be operational. ## Add initial files @@ -105,7 +106,8 @@ For front-end modules: package.json, .eslintrc, GitHub Workflows, etc. Get the initial basic source files and other configuration files added first. -New front-end repositories will use GitHub Actions Workflows (see our [document](/guidelines/github-actions-frontend/)). +New front-end repositories will use GitHub Actions Workflows (see our [document](/guidelines/github-actions-frontend/) +or follow an existing similar repository). When the code and configuration is in place, then this new repository needs to be manually added to Sonarcloud. Seek FOLIO DevOps [assistance](/faqs/how-to-raise-devops-ticket/). diff --git a/guidelines/index.md b/guidelines/index.md index d0222572..7b883957 100644 --- a/guidelines/index.md +++ b/guidelines/index.md @@ -45,7 +45,7 @@ and FOLIO Product Council ([PC](/reference/glossary/#pc)). has their "Definition of Ready ([DoR](/reference/glossary/#dor))" and "Definition of Done ([DoD](/reference/glossary/#dod))" to manage the development process. -- [Team and module responsibility matrix](https://wiki.folio.org/pages/viewpage.action?pageId=14463134). +- [Team and module responsibility matrix](https://folio-org.atlassian.net/wiki/x/plAV). - [Create a new FOLIO module and do initial setup](/guidelines/create-new-repo/). ## Other statements and policies diff --git a/guides/commence-a-module.md b/guides/commence-a-module.md index be6ab762..7422aa09 100644 --- a/guides/commence-a-module.md +++ b/guides/commence-a-module.md @@ -181,7 +181,7 @@ The `CHANGELOG.md` lists the main changes for each release. Follow how the other This is a typical directory layout, excluding the general boilerplate files and the usual JavaScript and CSS files: ``` -├── Jenkinsfile +├── .github/workflows/ ├── data/ │ ├── various ├── doc/ @@ -205,11 +205,6 @@ This is a typical directory layout, excluding the general boilerplate files and ├── en.json ``` -### Jenkinsfile {#front-end-jenkinsfile} - -The `Jenkinsfile` declares specific build steps for the continuous integration [process](/guides/automation/#jenkins). -See [explanation](/guides/jenkinsfile). - ### package.json {#front-end-packagejson} See the "[Stripes application metadata bundles](https://github.com/folio-org/stripes-core/blob/master/doc/app-metadata.md)" diff --git a/guides/devops-introduction.md b/guides/devops-introduction.md index f119aae9..32f55fbf 100644 --- a/guides/devops-introduction.md +++ b/guides/devops-introduction.md @@ -110,7 +110,7 @@ The "Add" button is way to the right-hand side. Developers can create their own Jira [accounts](/community/#collaboration-tools). -Occasionally a project manager (see [team matrix](https://wiki.folio.org/pages/viewpage.action?pageId=14463134)) will request special access to maintain the "Fix Version/s" settings. +Occasionally a project manager (see [team matrix](https://folio-org.atlassian.net/wiki/x/plAV)) will request special access to maintain the "Fix Version/s" settings. Visit the Jira admin "User management" and filter to find the relevant user. Add the Group "external-core-collaborators". diff --git a/guides/jenkinsfile.md b/guides/jenkinsfile.md index 964b0bb7..f1fe5fd6 100644 --- a/guides/jenkinsfile.md +++ b/guides/jenkinsfile.md @@ -16,7 +16,7 @@ The library primarily supports two types of development environments at this time -- Java-based Maven projects and Nodejs-based projects. The files and main parameters are explained below for -[back-end](#back-end-modules) and [front-end](#front-end-modules) modules. +[back-end](#back-end-modules). Each parameter can be omitted to accept the default. @@ -81,52 +81,7 @@ multi-call binary that contains `wget` with reduced number of options. ## Front-end modules -A typical Stripes or UI module Jenkinsfile configuration might look like the following. -See an example at -[ui-orders/Jenkinsfile](https://github.com/folio-org/ui-orders/blob/master/Jenkinsfile). - -(**Note**: Front-end modules are gradually being migrated to use GitHub Actions Workflows. So for those, Jenkinsfile is not relevant.) - -``` -buildNPM { - buildNode = 'jenkins-agent-java11' - publishModDescriptor = true - runLint = true - runTest = true - runTestOptions = '--karma.singleRun --karma.browsers=ChromeDocker' - runRegression = 'partial' -} -``` - -* `buildNode` -- The Jenkins node to run the CI build. -The default is `'jenkins-agent-java11'` if not specified (this utlises Node.js v14). -The other available option is `'jenkins-agent-java17'` (this utlises Node.js LTS v16). -Of course the CI does not use Java for front-end modules, but that is the naming convention for the build nodes. -* `publishModDescriptor` -- If a FOLIO Module Descriptor is defined in its [package.json](/guides/commence-a-module/#front-end-packagejson) -then the ModuleDescriptor.json will be generated and published to the FOLIO Module Descriptor registry. -(Default: false) - -* `runLint` -- Execute 'yarn lint' as part of the build. Ensure a 'lint' run script is -defined in package.json before enabling this option. -(Default: false) - -* `runTest` -- Execute 'yarn test' as part of the build. Ensure a 'test' run script is -defined in package.json. 'test' is typically used for unit tests. -(Default: false) - -* `runTestOptions` -- Provide 'yarn test' with additional options. -The example shows options for karma-based testing. - -* `sonarScanDirs` -- List of directories (comma-separated string) that the Sonarqube scanner should scan. -(Default: './src') - -* `runRegression` -- Execute the UI regression test suite from 'ui-testing' against a real -FOLIO backend. Option 'full' will execute the full test suite. Option 'partial' will execute only tests -specific to the UI module. Option 'none' will disable regression testing. -(Default: 'none') - -* `stripesPlatform` -- Specify which Stripes platform. -(Default: 'none', so build in "app" context.) +**Note**: Front-end modules are being migrated to use GitHub Actions Workflows. So for those, Jenkinsfile is not relevant. ## Further information