Skip to content
This repository has been archived by the owner on Nov 6, 2020. It is now read-only.

Autogen docs for the "Configuring Parity Ethereum" wiki page. #10067

Merged
merged 14 commits into from Jan 7, 2019

Conversation

jam10o-new
Copy link
Contributor

Working on the js side of this atm.

@jam10o-new jam10o-new added A3-inprogress ⏳ Pull request is in progress. No review needed at this stage. M1-ci 🙉 Continuous integration. M3-docs 📑 Documentation. labels Dec 14, 2018
@parity-cla-bot
Copy link

It looks like @joshua-mir signed our Contributor License Agreement. 👍

Many thanks,

Parity Technologies CLA Bot

@jam10o-new jam10o-new added this to the 2.3 milestone Dec 14, 2018
@jam10o-new jam10o-new added A0-pleasereview 🤓 Pull request needs code review. and removed A3-inprogress ⏳ Pull request is in progress. No review needed at this stage. labels Dec 24, 2018
@jam10o-new
Copy link
Contributor Author

depends on: paritytech/parity-config-generator#47

Copy link
Collaborator

@tomusdrw tomusdrw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Cool!

echo "_______Build config docs______"
npm install
npm run generate-data
npm run generate-docs
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems that this script will actually always use latest commit from master. In future it might be better to just use the checked out cli/mod.rs instead of having parity-config-generator fetching another one from master.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I went ahead and got this working 👍

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome 🎉 :)

adding an environment variable so js knows not to download git master and just grab the local repo
made some changes making this unnecessary
env variable passes to node properly now
Copy link
Collaborator

@tomusdrw tomusdrw left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

@@ -15,12 +16,19 @@ build_docs() {
npm run build:markdown
}

build_config() {
echo "_______Build config docs______"
npm install
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just noticed that parity-config-generator is using yarn (there is a yarn.lock there). Might be good to use yarn here as well (if available) so that we have the pinned versions while we install.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

it should be one or the other, right? should I use yarn install or npm install?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, I think we should use yarn install (if available in the docker image)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@joshua-mir let me know if any docker changes are required to use yarn.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ddorgan I'm still not super clear which image this runs in and where this script is run exactly, 😅 - yarn should just need an npm install -g yarn or the same in whatever package manager we have access to?

@jam10o-new
Copy link
Contributor Author

jam10o-new commented Jan 4, 2019

https://github.com/paritytech/wiki/compare/rpcdoc-update-pr-10067 seems to be the output of this currently
@Tbaut do you know why un is back in the rpc docs? 😢

edit: Ah, looks like that issue was never fixed. It's probably something outside the scope of this pr 😅

@jam10o-new jam10o-new changed the title [WIP] Autogen docs for the "Configuring Parity Ethereum" wiki page. Autogen docs for the "Configuring Parity Ethereum" wiki page. Jan 7, 2019
Very unlikely to be important/useful
scripts/gitlab/publish-docs.sh Show resolved Hide resolved
build_config() {
echo "_______Build config docs______"
yarn install
AUTOGENSCRIPT=1 yarn generate-docs
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to make it easier to debug, each commit to this branch goes compiling, and you can check the result here: https://gitlab.parity.io/parity/parity-ethereum/pipelines

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also,

  • the parity/rust:gitlab-ci docker image (aka default) was updated with yarn installation on master branch,
  • .gitlab-ci was updated for debugging purposes only:
  • runner was changed from shell to docker (ci2)
  • running priority was changed to optional
    all of it should be corrected before merging

git push origin HEAD
git push --tags
git push -q origin HEAD
git push -q --tags
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this suppression is good enough, build log: https://gitlab.parity.io/parity/parity-ethereum/-/jobs/114661

faced another problem though: it will fail if the tag with the same name exists, could be annoying for repeated builds, but not that critical, this is stage: optional all in all.

reverting .gitlab-ci changes in the next commit.

@TriplEight TriplEight merged commit 1fda997 into master Jan 7, 2019
@5chdn 5chdn deleted the autogen-config-docs branch January 7, 2019 13:49
@5chdn 5chdn mentioned this pull request Jan 7, 2019
15 tasks
5chdn pushed a commit that referenced this pull request Jan 7, 2019
* publish docs changes for autogen config docs

* Update publish-docs.sh

adding an environment variable so js knows not to download git master and just grab the local repo

* Update publish-docs.sh

made some changes making this unnecessary

* fix env variable

env variable passes to node properly now

* use yarn

* test pipeline, revert me

* fix test pipeline, revert me

* change runner tag

* change runner tag 2

* change runner tag

* global git config

* supress upload_files output

* Update .gitlab-ci.yml

reverting testing changes

* Replace tag if exists

Very unlikely to be important/useful
5chdn pushed a commit that referenced this pull request Jan 9, 2019
* publish docs changes for autogen config docs

* Update publish-docs.sh

adding an environment variable so js knows not to download git master and just grab the local repo

* Update publish-docs.sh

made some changes making this unnecessary

* fix env variable

env variable passes to node properly now

* use yarn

* test pipeline, revert me

* fix test pipeline, revert me

* change runner tag

* change runner tag 2

* change runner tag

* global git config

* supress upload_files output

* Update .gitlab-ci.yml

reverting testing changes

* Replace tag if exists

Very unlikely to be important/useful
5chdn added a commit that referenced this pull request Jan 9, 2019
* version: bump beta to v2.2.6

* Update pwasm-utils to 0.6.1 (#10134)

* version: mark upgrade critical on kovan

* Identity fix (#10128)

* fix #10125

fix service transaction version detection if --identity is enabled, change test to match how --identity actually works

* fix wrong var

* get the index of  v, not /

* idx, not idx.len()

* Update ethcore/sync/src/chain/propagator.rs

Co-Authored-By: joshua-mir <43032097+joshua-mir@users.noreply.github.com>

* Update ethcore/sync/src/chain/propagator.rs

Co-Authored-By: joshua-mir <43032097+joshua-mir@users.noreply.github.com>

* change version prefix to a const

* space

Co-Authored-By: joshua-mir <43032097+joshua-mir@users.noreply.github.com>

* [Hit return to continue]

* ethcore: update hardcoded headers for foundation

* ethcore: update hardcoded headers for ropsten

* ethcore: update hardcoded headers for kovan

* ethcore: use consistant formatting

* ethcore: restore spaces after colon in chain spec

* ethcore: fix bootnodes in chain specs

* ethcore: fix bootnodes in chain specs

* ethcore: enforce newline at the end of chainspecs

* Follow-up to #10105 (#10107)

* HF in POA Sokol (2019-01-04) (#10077)

* HF in POA Sokol (2019-01-04)

poanetwork/poa-chain-spec#91

* Update POA Core bootnodes

* Autogen docs for the "Configuring Parity Ethereum" wiki page. (#10067)

* publish docs changes for autogen config docs

* Update publish-docs.sh

adding an environment variable so js knows not to download git master and just grab the local repo

* Update publish-docs.sh

made some changes making this unnecessary

* fix env variable

env variable passes to node properly now

* use yarn

* test pipeline, revert me

* fix test pipeline, revert me

* change runner tag

* change runner tag 2

* change runner tag

* global git config

* supress upload_files output

* Update .gitlab-ci.yml

reverting testing changes

* Replace tag if exists

Very unlikely to be important/useful

* Autogen docs for the "Configuring Parity Ethereum" wiki page. (#10067)

* publish docs changes for autogen config docs

* Update publish-docs.sh

adding an environment variable so js knows not to download git master and just grab the local repo

* Update publish-docs.sh

made some changes making this unnecessary

* fix env variable

env variable passes to node properly now

* use yarn

* test pipeline, revert me

* fix test pipeline, revert me

* change runner tag

* change runner tag 2

* change runner tag

* global git config

* supress upload_files output

* Update .gitlab-ci.yml

reverting testing changes

* Replace tag if exists

Very unlikely to be important/useful

* finality: dont require chain head to be in the chain (#10054)

* Fill transaction hash on ethGetLog of light client. (#9938)

* Fill transaction hash on ethGetLog of light client. This is enifficient
but we keep align with spec.

* Using better variables names.

* Expose old fast light get log as `parity_getLogsLight`.

* Update rpc/src/v1/helpers/light_fetch.rs

Fix indent.

Co-Authored-By: cheme <emericchevalier.pro@gmail.com>

* Factor common code between light_logs and logs.

* Remove useless check

* Rename parity light logs to 'parity_getLogsNoTransactionHash'.
Fix indent and extra white lines.

* Use vec instead of tree map to avoid inner function.

* better loop

* fix pubsub new_blocks notifications to include all blocks (#9987)

Fix: new blocks notifications sometimes missing in pubsub RPC

Implement new struct to pass to `new_blocks()` with extra parameter - `has_more_blocks_to_import`, which was previously used to determine whether the notification should be sent. Now it's up to each implementation to decide what to do.

Updated all implementations to behave as before, except `eth_pubsub`, which will send notification even when the queue is not empty.

Update tests.

* Revert part of 70a6db7

* HF in POA Core (2019-01-18) - Constantinople (#10155)

poanetwork/poa-chain-spec#100

* ci: re-enable snap publishing (#10142)

* ci: enable snap publishing~

* ci: add publish snap script

* ci: add snapcraft skeleton

* ci: group export statements

* ci: enable snaps on pr branch

* ci: enable snaps on pr branch

* ci: set default BUILD_ARCH

* ci: enable snaps on pr branch

* ci: enable snaps on pr branch

* ci: add libdb to snap

* ci: reinitiate gitlabci

* ci: reinitiate publish-snap script

* ci: fix yaml syntax

* cargo/gitlab env vars

* debug, revert me

* version?

* debug vars

* vars

* vars fix

* vars fix

* revert

* Update scripts/gitlab/publish-snap.sh

Co-Authored-By: 5chdn <5chdn@users.noreply.github.com>

* ci: read track from cargo toml

* Make sure parent block is not in importing queue when importing ancient blocks (#10138)

* Make sure parent block is not in importing queue when importing ancient blocks

* Clear queue when an ancient import fails

* Lock only once in clear

* Add comments why queued check is needed

* Should push the value back to the queue

* Directly check in chain.read()

* Remove extra empty line

* Revert unused verification change
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
A0-pleasereview 🤓 Pull request needs code review. M1-ci 🙉 Continuous integration. M3-docs 📑 Documentation.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants