diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index ded34380b..22df24be0 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -8,6 +8,8 @@ We follow the [GitHub Flow](https://guides.github.com/introduction/flow/): all c Opening a Pull Request means you want that code to be merged. If you want to only discuss it, send a link to your branch along with your questions through whichever communication channel you prefer. +Please make sure (if you're changing the package; you don't have to for documentation or package health changes) to add to changelog_entry.yaml and run 'make changelog', then commit the results. + ### Peer reviews All pull requests must be reviewed by someone else than their original author. diff --git a/.github/workflows/pr.yml b/.github/workflows/pr.yml index 8f1206898..5dcf4e1c8 100644 --- a/.github/workflows/pr.yml +++ b/.github/workflows/pr.yml @@ -11,25 +11,6 @@ jobs: uses: "lgeiger/black-action@master" with: args: ". -l 79 --check" - check-version: - name: Check version - runs-on: ubuntu-latest - steps: - - uses: actions/checkout@v2 - with: - fetch-depth: 0 - repository: ${{ github.event.pull_request.head.repo.full_name }} - ref: ${{ github.event.pull_request.head.ref }} - - name: Set up Python - uses: actions/setup-python@v2 - with: - python-version: 3.9 - - name: Build changelog - run: pip install yaml-changelog && make changelog - - name: Preview changelog update - run: ".github/get-changelog-diff.sh" - - name: Check version number has been properly updated - run: ".github/is-version-number-acceptable.sh" Test: runs-on: ${{ matrix.os }} strategy: diff --git a/.github/workflows/push.yml b/.github/workflows/push.yml index 3c93efa49..cac7c7fcb 100644 --- a/.github/workflows/push.yml +++ b/.github/workflows/push.yml @@ -2,53 +2,21 @@ name: Push on: push: branches: [ master ] -env: - enhanced_frs: ${{ secrets.ENHANCED_FRS}} jobs: Lint: runs-on: ubuntu-latest if: | (github.repository == 'PolicyEngine/policyengine-uk') - && (github.event.head_commit.message == 'Update PolicyEngine UK') steps: - uses: actions/checkout@v2 - name: Check formatting uses: "lgeiger/black-action@master" with: args: ". -l 79 --check" - versioning: - name: Update versioning - if: | - (github.repository == 'PolicyEngine/policyengine-uk') - && !(github.event.head_commit.message == 'Update PolicyEngine UK') - runs-on: ubuntu-latest - steps: - - name: Checkout repo - uses: actions/checkout@v2 - with: - repository: ${{ github.event.pull_request.head.repo.full_name }} - ref: ${{ github.event.pull_request.head.ref }} - token: ${{ secrets.POLICYENGINE_GITHUB }} - - name: Setup Python - uses: actions/setup-python@v2 - with: - python-version: 3.9 - - name: Build changelog - run: pip install yaml-changelog && make changelog - - name: Preview changelog update - run: ".github/get-changelog-diff.sh" - - name: Update changelog - uses: EndBug/add-and-commit@v8 - with: - add: "." - committer_name: Github Actions[bot] - author_name: Github Actions[bot] - message: Update PolicyEngine UK Test: runs-on: ${{ matrix.os }} if: | (github.repository == 'PolicyEngine/policyengine-uk') - && (github.event.head_commit.message == 'Update PolicyEngine UK') strategy: matrix: os: [ubuntu-latest] @@ -82,7 +50,6 @@ jobs: Publish: if: | (github.repository == 'PolicyEngine/policyengine-uk') - && (github.event.head_commit.message == 'Update PolicyEngine UK') runs-on: ubuntu-latest steps: - name: Checkout repo @@ -104,7 +71,6 @@ jobs: Deploy: if: | (github.repository == 'PolicyEngine/policyengine-uk') - && (github.event.head_commit.message == 'Update PolicyEngine UK') runs-on: ubuntu-latest env: GH_TOKEN: ${{ secrets.POLICYENGINE_GITHUB }} diff --git a/PSL_catalog.json b/PSL_catalog.json index 6c156b65e..1d92378f9 100644 --- a/PSL_catalog.json +++ b/PSL_catalog.json @@ -1,24 +1,24 @@ { "name": "PolicyEngine UK", - "img": "https://avatars.githubusercontent.com/u/88570531?s=200&v=4", + "img": "https://github.com/PolicyEngine/policyengine-app/blob/master/src/images/logos/policyengine/banners/facebook.png?raw=true", "banner_title": "PolicyEngine UK", - "banner_subtitle": "A static microsimulation model of the UK Tax-Benefit system using the OpenFisca framework.", - "detailed_description": "PolicyEngine UK is PolicyEngine's microsimulation model of the UK tax-benefit system...", + "banner_subtitle": "A tax-benefit microsimulation model for the United Kingdom.", + "detailed_description": "PolicyEngine UK is PolicyEngine's microsimulation model of the UK tax-benefit system. It uses the PolicyEngine Core microsimulation framework, which is based on OpenFisca. The model supports multiple different input datasets provided by the user, one of which is the Family Resources Survey, containing microdata on household incomes across the UK. PolicyEngine UK enhances this dataset by fusing it to other surveys and reweighting it to minimize a comprehensive loss metric that measures the difference from an array of administrative totals.", "policy_area": "Policy Reform, Tax Analysis", - "geography": "Canada, United Kingdom, United States", + "geography": "United Kingdom", "language": "Python", "maintainers": [ - { - "name": "Nikhil Woodruff", - "image": "https://avatars.githubusercontent.com/u/35577657?v=4", - "link": "mailto:nikhil@policyengine.org" - } + { + "name": "Nikhil Woodruff", + "image": "https://avatars.githubusercontent.com/u/35577657?v=4", + "link": "https://github.com/nikhilwoodruff" + } ], "links": { - "code_repository": "https://github.com/PolicyEngine/policyengine-uk", - "user_documentation": "https://policyengine.github.io/policyengine-uk/", - "contributor_documentation": "https://github.com/PolicyEngine/PolicyEngine-uk", - "webapp": "https://policyengine.org/uk/calculator", - "recent_changes": "https://github.com/PSLmodels/policyengine-uk/blob/master/CHANGELOG.md" + "code_repository": "https://github.com/policyengine/policyengine-uk", + "user_documentation": "https://policyengine.github.io/policyengine-uk/", + "contributor_documentation": "https://github.com/PolicyEngine/policyengine-uk/blob/master/README.md", + "webapp": "https://policyengine.org/uk", + "recent_changes": "https://github.com/PolicyEngine/policyengine-uk/blob/master/CHANGELOG.md" } } \ No newline at end of file