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

Add deprecation warning #1570

Merged
merged 3 commits into from
Mar 21, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 3 additions & 14 deletions docs/Apm-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,9 @@ aragon apm info <apmRepo> [apmRepoVersion]

## aragon apm publish

> **Note**<br>
> This command is deprecated and will be removed in a future release. Please see the [Aragon Buidler plugin](https://github.com/aragon/buidler-aragon) for an improved development experience.

The `aragon apm publish` command publishes a new version to the aragonPM repo. Check the [Publish to aragonPM guide](https://hack.aragon.org/docs/guides-publish) to learn more about the publish workflow.

```sh
Expand Down Expand Up @@ -65,20 +68,6 @@ The command has the following parameters:
- `--propagate-content`: Whether to propagate the content once published. Defaults to `true`.
- `--skip-confirmation`: Whether to skip the confirmation step. Defaults to `false`.

## aragon apm extract-functions

Extract function information from a Solidity file.

```sh
aragon apm extract-functions [contract]
```

- `contract`: Path to the Solidity file to extract functions from.

Options:

- `--output`: Path of the directory where the output file will be saved to.

## aragon apm versions

Shows all the previously published versions of a given repository.
Expand Down
15 changes: 6 additions & 9 deletions docs/Main-commands.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,9 @@ These are general purpose commands that will help you to set up and interact wit

## aragon run

> **Note**<br>
> This command is deprecated and will be removed in a future release. Please see the [Aragon Buidler plugin](https://github.com/aragon/buidler-aragon) for an improved development experience.

The `run` command takes care of completely setting up the environment needed for running your Aragon app.

```sh
Expand Down Expand Up @@ -120,6 +123,9 @@ Options:

## aragon deploy

> **Note**<br>
> This command is deprecated and will be removed in a future release. Please see the [Aragon Buidler plugin](https://github.com/aragon/buidler-aragon) for an improved development experience.

The `deploy` command can be used for deploying an Ethereum contract to the devchain.

```sh
Expand All @@ -134,12 +140,3 @@ Options:

- `--init`: Arguments to be passed to contract constructor on deploy. Need to be separated by a space. The `@ARAGON_ENS` alias can be used and it will be replaced by the address of the ENS registry in the devchain.

## aragon contracts

The `aragon contracts` command can be used to execute commands using the same [truffle](https://github.com/trufflesuite/truffle) version that aragonCLI uses behind the scenes to assist in compiling your app's contracts.

```sh
aragon contracts <command>
```

It is equivalent to executing `npx truffle <command>`
4 changes: 4 additions & 0 deletions packages/cli/src/commands/apm_cmds/publish.js
Original file line number Diff line number Diff line change
Expand Up @@ -157,6 +157,10 @@ export const handler = async function({
propagateContent,
skipConfirmation,
}) {
reporter.warning(
'This command is deprecated and will be removed in a future release. Please see the Aragon Buidler plugin for an improved development experience: https://github.com/aragon/buidler-aragon'
)

web3 = web3 || (await ensureWeb3(network))

const {
Expand Down
4 changes: 4 additions & 0 deletions packages/cli/src/commands/deploy.js
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,10 @@ export const handler = async ({
silent,
debug,
}) => {
reporter.warning(
'This command is deprecated and will be removed in a future release. Please see the Aragon Buidler plugin for an improved development experience: https://github.com/aragon/buidler-aragon'
)

const tasks = await task({
module,
reporter,
Expand Down
4 changes: 4 additions & 0 deletions packages/cli/src/commands/run.js
Original file line number Diff line number Diff line change
Expand Up @@ -222,6 +222,10 @@ export const handler = async function({
clientPort,
clientPath,
}) {
reporter.warning(
'This command is deprecated and will be removed in a future release. Please see the Aragon Buidler plugin for an improved development experience: https://github.com/aragon/buidler-aragon'
)

if (http && !(await isHttpServerOpen(http))) {
throw Error(
`Can't connect to ${http}, make sure the http server is running.`
Expand Down