Merge pull request #297 from ASFHyP3/develop

Release: v0.8.1

.github/workflows/deploy.yml

@@ -9,6 +9,7 @@ on:
 env:
   AWS_REGION: us-west-2
   TEMPLATE_BUCKET: cf-templates-aubvn3i9olmk-us-west-2
+  MONTHLY_JOB_QUOTA_PER_USER: 200
 
   VPC_ID: ${{ secrets.VPC_ID }}
   SUBNET_IDS: ${{ secrets.SUBNET_IDS }}
@@ -78,7 +79,8 @@ jobs:
                 EDLPassword="${EDL_PASSWORD}" \
                 ImageTag="${IMAGE_TAG}" \
                 DomainName="${DOMAIN_NAME}" \
-                CertificateArn="${CERTIFICATE_ARN}"
+                CertificateArn="${CERTIFICATE_ARN}" \
+                MonthlyJobQuotaPerUser="${MONTHLY_JOB_QUOTA_PER_USER}"
 
       - name: Get associated PR
         if: github.ref == 'refs/heads/master'

.github/workflows/deploy_autorift.yml

@@ -11,6 +11,7 @@ env:
   STACK_NAME: hyp3-autorift
   DOMAIN_NAME: hyp3-autorift.asf.alaska.edu
   IMAGE_TAG: latest
+  MONTHLY_JOB_QUOTA_PER_USER: 0
 
   VPC_ID: ${{ secrets.AUTORIFT_VPC_ID }}
   SUBNET_IDS: ${{ secrets.AUTORIFT_SUBNET_IDS }}
@@ -63,4 +64,5 @@ jobs:
                 EDLPassword="${EDL_PASSWORD}" \
                 ImageTag="${IMAGE_TAG}" \
                 DomainName="${DOMAIN_NAME}" \
-                CertificateArn="${CERTIFICATE_ARN}"
+                CertificateArn="${CERTIFICATE_ARN}" \
+                MonthlyJobQuotaPerUser="${MONTHLY_JOB_QUOTA_PER_USER}"

CHANGELOG.md

@@ -4,11 +4,20 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [0.8.1]
+### Added
+- Added Code of Conduct and Contributing Guidelines
+
+### Changed
+- `MonthlyJobQuotaPerUser` stack parameter no longer has a default, and the value can now be set to zero.
+  - Value is now set to `200` for ASF deployments.
+  - Value is now set to `0` for the autoRIFT deployment.
+- `POST /jobs` requests now allow up to 200 jobs per request, up from 25
+
 ## [0.8.0]
 ### Added
 - User table which can be used to add custom quotas for users, users not in the table will still have the default.
-- GET /jobs/{job_id} API endpoint to search for a job by its job_id 
-
+- GET /jobs/{job_id} API endpoint to search for a job by its job_id
 
 ## [0.7.5]
 ### Added

CODE_OF_CONDUCT.md

@@ -0,0 +1,129 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, religion, or sexual identity
+and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the
+  overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official e-mail address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement by emailing the
+ASF APD/Tools team at [[email protected]](mailto:[email protected]).
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series
+of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or
+permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior,  harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within
+the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.0, available at
+https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct
+enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at
+https://www.contributor-covenant.org/translations.
+

CONTRIBUTING.md

@@ -0,0 +1,77 @@
+# Contributing
+
+Thank you for your interest in helping make custom on-demand SAR processing accessible!
+
+We're excited you would like to contribute to HyP3! Whether you're finding bugs, adding new features, fixing anything broken, or improving documentation, get started by submitting an issue or pull request!
+
+## Submitting an Issue
+
+If you have any questions or ideas, or notice any problems or bugs, first [search open issues](https://github.com/ASFHyP3/hyp3/issues) to see if the issue has already been submitted. We may already be working on the issue. If you think your issue is new, you're welcome to [create a new issue](https://github.com/ASFHyP3/hyp3/issues/new).
+
+## Pull Requests are welcome
+
+Found a typo, know how to fix a bug, want to update the docs, want to add a new feature? Great!
+
+The smaller the PR, the easier it is to review and test and the more likely it is to be successful.
+
+For major contributions, consider opening [an issue](https://github.com/ASFHyP3/hyp3/issues/new) describing the contribution so we can help guide and breakup the work into digestible pieces.
+
+### Workflow
+If you want to submit your own contributions, please use a [forking workflow](https://www.atlassian.com/git/tutorials/comparing-workflows/forking-workflow).
+
+The basic steps are:
+1. Fork the repository
+
+2. Clone your fork
+   ```
+   git clone https://github.com/[OWNER]/hyp3.git
+   ```
+3. Add this repository as an `upstream` remote
+   ```
+   git remote add upstream https://github.com/ASFHyP3/hyp3.git
+   ```  
+4. Create a feature branch based on the upstream/develop branch
+   ```
+   git fetch --all --prune
+   git checkout --no-track -b [NAME] upstream/develop
+   ```
+5. Make your changes! Then push them to your fork
+   ```
+   git push -u origin [NAME]
+   ```
+6. Propose your changes by opening a pull request to `ASFHyP3/hyp3`'s `develop` branch
+
+## Guidelines
+
+We ask that you follow these guidelines with your contributions
+
+### Style
+
+We generally follow python community standards ([PEP8](https://pep8.org/)), except we allow line lengths up to 120 characters. We recommend trying to keep lines 80--100 characters long, but allow up to 120 when it improves readability.
+
+### Documentation
+
+We are working to improve our documentation!
+
+For all public-facing functions/methods (not [marked internal use](https://www.python.org/dev/peps/pep-0008/#naming-conventions)), please include [type hints](https://google.github.io/styleguide/pyguide.html#221-type-annotated-code) (when reasonable) and a [docstring](https://www.python.org/dev/peps/pep-0257/) formatted [Google style](https://google.github.io/styleguide/pyguide.html#38-comments-and-docstrings).
+
+
+### Tests
+
+All of the automated tests for this project need to pass before your submission will be accepted.
+
+If you add new functionality, please add tests for that functionality as well.
+
+### Commits
+
+* Make small commits that show the individual changes you are making
+* Write descriptive commit messages that explain your changes
+
+Example of a good commit message;
+
+```
+Improve contributing guidelines. Fixes #10
+
+Improve contributing docs and consolidate them in the standard location
+https://help.github.com/articles/setting-guidelines-for-repository-contributors/
+```

apps/api/src/hyp3_api/api-spec/openapi-spec.yml

@@ -154,7 +154,7 @@ components:
       description: Contains a list of new job objects.
       type: array
       minItems: 1
-      maxItems: 25
+      maxItems: 200
       items:
         $ref: "#/components/schemas/new_job"
 

apps/main-cf.yml

@@ -48,8 +48,7 @@ Parameters:
   MonthlyJobQuotaPerUser:
     Description: Number of jobs each user is allowed per month.
     Type: Number
-    MinValue: 1
-    Default: 25
+    MinValue: 0
 
   SystemAvailable:
     Description: Set to false to shutdown system, API will run and provide errors to users, but will not accept jobs.