Skip to content

Commit

Permalink
Merge pull request #6 from 0xPolygon/changes
Browse files Browse the repository at this point in the history
release workflow
  • Loading branch information
nitinmittal23 committed Oct 3, 2023
2 parents 5d5f4a2 + bca1be5 commit 3b7a148
Show file tree
Hide file tree
Showing 110 changed files with 5,265 additions and 290 deletions.
2 changes: 1 addition & 1 deletion .github/pull_request_templates/ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,4 @@ Steps before creating an issue:

#### Environment

<!-- e.g. Versions used of: npm, Node, chainflow, OS, device -->
<!-- e.g. Versions used of: npm, Node, chain-indexer-framework, OS, device -->
29 changes: 0 additions & 29 deletions .github/workflows/npm-release.yml

This file was deleted.

39 changes: 39 additions & 0 deletions .github/workflows/release.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
name: NPM Semantic Release

on:
push:
branches: ['main']

jobs:
Deployment:
name: Publish Chain Indexer Framework
runs-on: ubuntu-latest
env:
working-directory: ./
permissions:
contents: read
packages: write
steps:
- name: CHECK-OUT GIT REPOSITORY
uses: actions/checkout@v3
with:
persist-credentials: false
fetch-depth: 0

- name: Use Node.js
uses: actions/setup-node@v3
with:
node-version: '18.x'
registry-url: 'https://npm.pkg.github.com'

- name: Install dependencies
run: npm install

- name: Build
run: npm run build

- name: Run semantic-release
run: npx semantic-release
env:
GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
NPM_TOKEN: ${{ secrets.NPM_AUTH_TOKEN }}
1 change: 0 additions & 1 deletion .github/workflows/tests.yml
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
name: Tests
run-name: ${{ github.actor }} just pushed to ChainFlow

on:
push:
Expand Down
3 changes: 0 additions & 3 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,3 @@ package-lock.json
*.key
*.cert
pids/

#packages/services/producers/ethereum/taskdef
#Dockerfile.ethereum-producer
12 changes: 6 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,21 +4,21 @@ In this guide you will get an overview of the contribution workflow from opening

## Feature requests

If you find yourself wishing for a feature that doesn't exist in Chainflow, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that Chainflow has today have been added because our users saw the need. Open an issue on our issues list on GitHub which describes the feature you would like to see, why you need it, and how it should work.
If you find yourself wishing for a feature that doesn't exist in Chain Indexer Framework, you are probably not alone. There are bound to be others out there with similar needs. Many of the features that Chain Indexer Framework has today have been added because our users saw the need. Open an issue on our issues list on GitHub which describes the feature you would like to see, why you need it, and how it should work.

### How to Get in Touch

Our active Discord community is always ready to help and support new and experienced contributors alike. Link

## Contributing code and documentation changes

If you would like to contribute a new feature or a bug fix to **Chainflow**, please discuss your idea first on the GitHub issue. If there is no GitHub issue for your idea, please open one. It may be that somebody is already working on it, or that there are particular complexities that you should know about before starting the implementation. There are often a number of ways to fix a problem and it is important to find the right approach before spending time on a PR that cannot be merged.
If you would like to contribute a new feature or a bug fix to **Chain Indexer Framework**, please discuss your idea first on the GitHub issue. If there is no GitHub issue for your idea, please open one. It may be that somebody is already working on it, or that there are particular complexities that you should know about before starting the implementation. There are often a number of ways to fix a problem and it is important to find the right approach before spending time on a PR that cannot be merged.

We add the `help wanted` label to existing GitHub issues for which community contributions are particularly welcome, and we use the `good first issue` label to mark issues that we think will be suitable for new contributors.

### Fork and clone the repository

You will need to fork the main **Chainflow** code or documentation repository and clone it to your local machine. See [github help page](https://help.github.com/articles/fork-a-repo) for help.
You will need to fork the main **Chain Indexer Framework** code or documentation repository and clone it to your local machine. See [github help page](https://help.github.com/articles/fork-a-repo) for help.

Further instructions for specific projects are given below.

Expand All @@ -41,13 +41,13 @@ Once your changes and tests are ready to submit for review:

2. Rebase your changes

Update your local repository with the most recent code from the main **Chainflow** repository, and rebase your branch on top of the latest main branch. We prefer your initial changes to be squashed into a single commit. Later, if we ask you to make changes, add them as separate commits. This makes them easier to review. As a final step before merging we will either ask you to squash all commits yourself or we'll do it for you.
Update your local repository with the most recent code from the main **Chain Indexer Framework** repository, and rebase your branch on top of the latest main branch. We prefer your initial changes to be squashed into a single commit. Later, if we ask you to make changes, add them as separate commits. This makes them easier to review. As a final step before merging we will either ask you to squash all commits yourself or we'll do it for you.

3. Submit a pull request

Push your local changes to your forked copy of the repository and [submit a pull request](https://help.github.com/articles/using-pull-requests). In the pull request, choose a title which sums up the changes that you have made, and in the body provide more details about what your changes do. Also mention the number of the issue where discussion has taken place, eg "Closes #123".

Then sit back and wait. There will probably be discussion about the pull request and, if any changes are needed, we would love to work with you to get your pull request merged into **Chainflow**.
Then sit back and wait. There will probably be discussion about the pull request and, if any changes are needed, we would love to work with you to get your pull request merged into **Chain Indexer Framework**.

Please adhere to the general guideline that you should never force push to a publicly shared branch. Once you have opened your pull request, you should consider your branch publicly shared. Instead of force pushing you can just add incremental commits; this is generally easier on your reviewers. If you need to pick up changes from main, you can merge main into your branch. A reviewer might ask you to rebase a long-running pull request in which case force pushing is okay for that request. Note that squashing at the end of the review process should also not be done, that can be done when the pull request is [integrated via GitHub](https://github.com/blog/2141-squash-your-commits).

Expand Down Expand Up @@ -79,4 +79,4 @@ Read more in [Review Guidelines](./REVIEW.md).

### License

By contributing to **Chainflow**, you agree that your contributions will be licensed under its [license](./LICENSE).
By contributing to **Chain Indexer Framework**, you agree that your contributions will be licensed under its [license](./LICENSE).
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2023 Polygon (previously Matic)
Copyright (c) 2023 PT Services DMCC

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
Loading

0 comments on commit 3b7a148

Please sign in to comment.