geniusyield / atlas Goto Github PK

https://www.conventionalcommits.org/en/v1.0.0/

We really need to test whether we are able to successfully query information using our provider.

Thinking of golden tests over set of specified UTxOs in Preprod.

Problem:

• The spelling of the badge titles is a bit mixed up. Some of them are capitalized, others are not.

Solution:

• Capitalize all the status badges.

TODO:

• The recently released v0.2.0 of Atlas must be still released to Hackage.

Blocked by:

• #128

Resources:

• https://about.codecov.io/
• https://github.com/killy971/codecov-haskell
• https://hackage.haskell.org/package/codecov-haskell
• https://wiki.haskell.org/Haskell_program_coverage

Problem:

1. Currently we are using older refs for haskell.nix & plutus which is blocking to use new GHC version.
2. Hackage Index-state issue

Solution:
use latest tag & update flake.nix

Problem:

• The haddock link in the documentation section of the README is broken:

Solution:

• Make sure that the haddock link leads to the generated haddock documentation.

Problem:

• The documentation is not deployed automatically.

Solution:

• Setup deployment using GitHub Pages.

This argument will drastically shrink the log size by excluding logs from passed tests.

Problem:

• No pull request template has been defined.

Solution:

• Define a pull request temple.

Resources:

• GitHub Community Standards
• Open Source Guides

We need to improve it.

Problem:

• The pre-commit-hooks are not in the Atlas repo.

Solution:

• Move the pre-commit-hooks in to the Atlas repo.

From documentation:

There should be a parity b/w these users.

Problem:

• A warning with the message "Tab character found here, and in two further locations." is logged when the GHA Run is done:

Solution:

• Make sure that there are no warning logged when the build is node.

Resources:

• Example job with the mentioned warning as annotation: GHA Run 4573995804

Problem:

• The release notes generation should be automated.

Problem:

• At the moment there is no proper release workflow for GitHub Actions.

Solution:

• Implement a release workflow.

Resources:

• GitHub Documentation: About packaging with GitHub Actions
• Example workflow:

name: Demo Push

on:
  push:
    # Publish `main` as Docker `latest` image.
    branches:
      - main
      - seed

    # Publish `v1.2.3` tags as releases.
    tags:
      - v*

  # Run tests for any PRs.
  pull_request:

env:
  IMAGE_NAME: ghtoken_product_demo

jobs:
  # Push image to GitHub Packages.
  # See also https://docs.docker.com/docker-hub/builds/
  push:
    runs-on: ubuntu-latest
    permissions:
      packages: write
      contents: read

    steps:
      - uses: actions/checkout@v3

      - name: Build image
        run: docker build . --file Dockerfile --tag $IMAGE_NAME --label "runnumber=${GITHUB_RUN_ID}"

      - name: Log in to registry
        # This is where you will update the personal access token to GITHUB_TOKEN
        run: echo "${{ secrets.GITHUB_TOKEN }}" | docker login ghcr.io -u $ --password-stdin

      - name: Push image
        run: |
          IMAGE_ID=ghcr.io/${{ github.repository_owner }}/$IMAGE_NAME

          # Change all uppercase to lowercase
          IMAGE_ID=$(echo $IMAGE_ID | tr '[A-Z]' '[a-z]')
          # Strip git ref prefix from version
          VERSION=$(echo "${{ github.ref }}" | sed -e 's,.*/\(.*\),\1,')
          # Strip "v" prefix from tag name
          [[ "${{ github.ref }}" == "refs/tags/"* ]] && VERSION=$(echo $VERSION | sed -e 's/^v//')
          # Use Docker `latest` tag convention
          [ "$VERSION" == "main" ] && VERSION=latest
          echo IMAGE_ID=$IMAGE_ID
          echo VERSION=$VERSION
          docker tag $IMAGE_NAME $IMAGE_ID:$VERSION
          docker push $IMAGE_ID:$VERSION

Problem:

• The build status is not shown in the status badges.

Solution:

• Add a status badge showing the main build status.

The framework should start to require and take advantage of pagination in some of its Core provider functions. For example, fetching all UTxOs at an address should be a paginated operation ideally.

This would greatly help the orderbot framework. But in reality, this is a fundamental improvement that is crucial for HTTP based providers (blockfrost, maestro etc.).

Problem:

• At the moment there is no pre-commit hook configured to prevent commits to the main branch

Solution:

• Add a pre-commit hook that prevents commits to the main branch.

Is there any use of it?

Problem:

• At the moment there are quite a few TODO comments in the code, which are hard to track, manage and prioritize.

Solution:

• Create issues for the TODO comments, so these could be planned, prioritized and tracked.

Describe the issue with the documentation
The GitHub Actions Badge is leading to the Haskell workflow, which is never executed

Suggest a solution
Instead of linking to the Haskell workflow, we should use a link pointing to the build workflow filtered for the main branch

Additional context
This issue is about a problem with the GitHub Actions status badge in the README file.

Problem:

• The doctests are not included in the CI pipeline.

Solution:

• Integrate the doctests into the CI pipeline.

Resources:

Commands to run the doctests:

curl -sL https://github.com/phadej/cabal-extras/releases/download/cabal-docspec-0.0.0.20211114/cabal-docspec-0.0.0.20211114.xz > ./cabal-docspec.xz
xz -d < ./cabal-docspec.xz > ./cabal-docspec
rm -f ./cabal-docspec.xz
chmod a+x ./cabal-docspec
./cabal-docspec

If a reference input's datum is not inlined, we can query for the datum using it's hash (provided it was there at this UTxOs generation time) and pass for it.

Problem:

• An empty wiki page is shown, but we are not planning on using the wiki.

Solution:

• Disable the Wiki feature/tab for the Atlas repo.

We removed the support for chain-index when getting rid of plutus-apps, need to figure out local option for our lookupDatum.

Atlas should have more tests running for its own than having it's old house do for it.