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

datagov-harvesting repository setup #4255

Closed
1 task done
jbrown-xentity opened this issue Mar 23, 2023 · 1 comment
Closed
1 task done

datagov-harvesting repository setup #4255

jbrown-xentity opened this issue Mar 23, 2023 · 1 comment
Assignees

Comments

@jbrown-xentity
Copy link
Contributor

jbrown-xentity commented Mar 23, 2023

User Story

In order to write simple python code, data.gov admins want a streamlined GitHub Repository with all the components built in.

Acceptance Criteria

[ACs should be clearly demoable/verifiable whenever possible. Try specifying them using BDD.]

  • GIVEN a repository exists for data.gov harvesting in python
    WHEN a PR is created
    THEN automated tests occur (linting and tests)
    AND a code coverage report is generated on the PR
    AND a snyk scan is run
    AND a PR template is utilized
    AND a README of the idealized code structure is implemented

Background

https://github.com/GSA/GitHub-Administration#each-repository-should
https://github.com/18F/django-template

Security Considerations (required)

None

Sketch

We need to create a new repository for this, something like datagov-harvesting (maybe since we don't know the final utilization of this code, we should use something less generic, something like datagov-harvesting-logic?).
We want to take the good from some of the stuff we've done on our CKAN extensions, but improve the simplicity. We want a "typical" python developer to be able to come on and plug in.

  • Use docker and/or docker-compose only when necessary for other services; another repository will be utilized to verify platform and library compatibility for deployment (whether on cloud.gov, or on Lambda)
  • Use poetry that allows for locking and doesn't require our current janky setup.
  • Utilize poetry for saved commands like running tests, don't rely on Makefile.
  • Use github actions that facilitate the necessary requirements that we already use, such as linting and pytest with coverage
  • Limit bash scripting, as it can be non-portable between unix/linux
@hkdctol hkdctol moved this to 📔 Product Backlog in data.gov team board Mar 30, 2023
@jbrown-xentity jbrown-xentity moved this from 📔 Product Backlog to 📟 Sprint Backlog [7] in data.gov team board Mar 30, 2023
@Jin-Sun-tts Jin-Sun-tts self-assigned this Apr 3, 2023
@Jin-Sun-tts Jin-Sun-tts moved this from 📟 Sprint Backlog [7] to 🏗 In Progress [8] in data.gov team board Apr 3, 2023
@Jin-Sun-tts
Copy link
Contributor

created repo here: https://github.com/GSA/datagov-harvesting-logic

@hkdctol hkdctol added the H2.0/Harvest-General General Harvesting 2.0 Issues label Apr 11, 2023
@Jin-Sun-tts Jin-Sun-tts moved this from 🏗 In Progress [8] to ✔ Done in data.gov team board Apr 13, 2023
@hkdctol hkdctol closed this as completed Apr 13, 2023
@btylerburton btylerburton added H2.0/orchestrator and removed H2.0/Harvest-General General Harvesting 2.0 Issues labels Dec 13, 2023
@btylerburton btylerburton moved this from ✔ Done to 🗄 Closed in data.gov team board Dec 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

4 participants