forked from DSpace/DSpace
-
Notifications
You must be signed in to change notification settings - Fork 63
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge remote-tracking branch 'origin/dspace-cris-7' into DSC-1105
- Loading branch information
Showing
485 changed files
with
20,674 additions
and
5,451 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,59 @@ | ||
# DSpace CodeQL code scanning configuration for GitHub | ||
# https://docs.github.com/en/code-security/code-scanning | ||
# | ||
# NOTE: Code scanning must be run separate from our default build.yml | ||
# because CodeQL requires a fresh build with all tests *disabled*. | ||
name: "Code Scanning" | ||
|
||
# Run this code scan for all pushes / PRs to main branch. Also run once a week. | ||
on: | ||
push: | ||
branches: [ main ] | ||
pull_request: | ||
branches: [ main ] | ||
# Don't run if PR is only updating static documentation | ||
paths-ignore: | ||
- '**/*.md' | ||
- '**/*.txt' | ||
schedule: | ||
- cron: "37 0 * * 1" | ||
|
||
jobs: | ||
analyze: | ||
name: Analyze Code | ||
runs-on: ubuntu-latest | ||
# Limit permissions of this GitHub action. Can only write to security-events | ||
permissions: | ||
actions: read | ||
contents: read | ||
security-events: write | ||
|
||
steps: | ||
# https://github.com/actions/checkout | ||
- name: Checkout repository | ||
uses: actions/checkout@v3 | ||
|
||
# https://github.com/actions/setup-java | ||
- name: Install JDK | ||
uses: actions/setup-java@v3 | ||
with: | ||
java-version: 11 | ||
distribution: 'temurin' | ||
|
||
# Initializes the CodeQL tools for scanning. | ||
# https://github.com/github/codeql-action | ||
- name: Initialize CodeQL | ||
uses: github/codeql-action/init@v2 | ||
with: | ||
# Codescan Javascript as well since a few JS files exist in REST API's interface | ||
languages: java, javascript | ||
|
||
# Autobuild attempts to build any compiled languages | ||
# NOTE: Based on testing, this autobuild process works well for DSpace. A custom | ||
# DSpace build w/caching (like in build.yml) was about the same speed as autobuild. | ||
- name: Autobuild | ||
uses: github/codeql-action/autobuild@v2 | ||
|
||
# Perform GitHub Code Scanning. | ||
- name: Perform CodeQL Analysis | ||
uses: github/codeql-action/analyze@v2 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -5,25 +5,22 @@ on: | |
issues: | ||
types: [opened] | ||
|
||
permissions: {} | ||
jobs: | ||
automation: | ||
runs-on: ubuntu-latest | ||
steps: | ||
# Add the new issue to a project board, if it needs triage | ||
# See https://github.com/marketplace/actions/create-project-card-action | ||
- name: Add issue to project board | ||
# See https://github.com/actions/add-to-project | ||
- name: Add issue to triage board | ||
# Only add to project board if issue is flagged as "needs triage" or has no labels | ||
# NOTE: By default we flag new issues as "needs triage" in our issue template | ||
if: (contains(github.event.issue.labels.*.name, 'needs triage') || join(github.event.issue.labels.*.name) == '') | ||
uses: technote-space/create-project-card-action@v1 | ||
uses: actions/[email protected] | ||
# Note, the authentication token below is an ORG level Secret. | ||
# It must be created/recreated manually via a personal access token with "public_repo" and "admin:org" permissions | ||
# It must be created/recreated manually via a personal access token with admin:org, project, public_repo permissions | ||
# See: https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token#permissions-for-the-github_token | ||
# This is necessary because the "DSpace Backlog" project is an org level project (i.e. not repo specific) | ||
with: | ||
GITHUB_TOKEN: ${{ secrets.ORG_PROJECT_TOKEN }} | ||
PROJECT: DSpace Backlog | ||
COLUMN: Triage | ||
CHECK_ORG_PROJECT: true | ||
# Ignore errors. | ||
continue-on-error: true | ||
github-token: ${{ secrets.TRIAGE_PROJECT_TOKEN }} | ||
project-url: https://github.com/orgs/DSpace/projects/24 |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,45 @@ | ||
# How to Contribute | ||
|
||
DSpace is a community built and supported project. We do not have a centralized development or support team, but have a dedicated group of volunteers who help us improve the software, documentation, resources, etc. | ||
|
||
* [Contribute new code via a Pull Request](#contribute-new-code-via-a-pull-request) | ||
* [Contribute documentation](#contribute-documentation) | ||
* [Help others on mailing lists or Slack](#help-others-on-mailing-lists-or-slack) | ||
* [Join a working or interest group](#join-a-working-or-interest-group) | ||
|
||
## Contribute new code via a Pull Request | ||
|
||
We accept [GitHub Pull Requests (PRs)](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request-from-a-fork) at any time from anyone. | ||
Contributors to each release are recognized in our [Release Notes](https://wiki.lyrasis.org/display/DSDOC7x/Release+Notes). | ||
|
||
Code Contribution Checklist | ||
- [ ] PRs _should_ be smaller in size (ideally less than 1,000 lines of code, not including comments & tests) | ||
- [ ] PRs **must** pass Checkstyle validation based on our [Code Style Guide](https://wiki.lyrasis.org/display/DSPACE/Code+Style+Guide). | ||
- [ ] PRs **must** include Javadoc for _all new/modified public methods and classes_. Larger private methods should also have Javadoc | ||
- [ ] PRs **must** pass all automated tests and include new/updated Unit or Integration tests based on our [Code Testing Guide](https://wiki.lyrasis.org/display/DSPACE/Code+Testing+Guide). | ||
- [ ] If a PR includes new libraries/dependencies (in any `pom.xml`), then their software licenses **must** align with the [DSpace BSD License](https://github.com/DSpace/DSpace/blob/main/LICENSE) based on the [Licensing of Contributions](https://wiki.lyrasis.org/display/DSPACE/Code+Contribution+Guidelines#CodeContributionGuidelines-LicensingofContributions) documentation. | ||
- [ ] Basic technical documentation _should_ be provided for any new features or changes to the REST API. REST API changes should be documented in our [Rest Contract](https://github.com/DSpace/RestContract). | ||
- [ ] If a PR fixes an issue ticket, please [link them together](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue). | ||
|
||
Additional details on the code contribution process can be found in our [Code Contribution Guidelines](https://wiki.lyrasis.org/display/DSPACE/Code+Contribution+Guidelines) | ||
|
||
## Contribute documentation | ||
|
||
DSpace Documentation is a collaborative effort in a shared Wiki. The latest documentation is at https://wiki.lyrasis.org/display/DSDOC7x | ||
|
||
If you find areas of the DSpace Documentation which you wish to improve, please request a Wiki account by emailing [email protected]. | ||
Once you have an account setup, contact @tdonohue (via [Slack](https://wiki.lyrasis.org/display/DSPACE/Slack) or email) for access to edit our Documentation. | ||
|
||
## Help others on mailing lists or Slack | ||
|
||
DSpace has our own [Slack](https://wiki.lyrasis.org/display/DSPACE/Slack) community and [Mailing Lists](https://wiki.lyrasis.org/display/DSPACE/Mailing+Lists) where discussions take place and questions are answered. | ||
Anyone is welcome to join and help others. We just ask you to follow our [Code of Conduct](https://www.lyrasis.org/about/Pages/Code-of-Conduct.aspx) (adopted via LYRASIS). | ||
|
||
## Join a working or interest group | ||
|
||
Most of the work in building/improving DSpace comes via [Working Groups](https://wiki.lyrasis.org/display/DSPACE/DSpace+Working+Groups) or [Interest Groups](https://wiki.lyrasis.org/display/DSPACE/DSpace+Interest+Groups). | ||
|
||
All working/interest groups are open to anyone to join and participate. A few key groups to be aware of include: | ||
|
||
* [DSpace 7 Working Group](https://wiki.lyrasis.org/display/DSPACE/DSpace+7+Working+Group) - This is the main (mostly volunteer) development team. We meet weekly to review our current development [project board](https://github.com/orgs/DSpace/projects), assigning tickets and/or PRs. | ||
* [DSpace Community Advisory Team (DCAT)](https://wiki.lyrasis.org/display/cmtygp/DSpace+Community+Advisory+Team) - This is an interest group for repository managers/administrators. We meet monthly to discuss DSpace, share tips & provide feedback back to developers. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.