Site-www: automate updates of the diagnostic messages page

Created on 25 Sep 2019  路  3Comments  路  Source: dart-lang/site-www

See #1892 for details

e1-hours e2-days help wanted infrastructure p2-medium

All 3 comments

Here's the process I'm doing by hand (see #2136 for an example):

  1. Create a new branch of my site-www repo.

  2. Go to https://github.com/dart-lang/sdk/blob/master/pkg/analyzer/tool/diagnostics/diagnostics.md, click the Raw button, and Save as _pathToRepo_/src/tools/diagnostic-messages.md.

  3. Commit the changes, then view the diffs and make sure they look reasonable. If you need to make changes, then make them in a separate commit.

  4. Stage the file to make sure it has no obvious formatting issues.

  5. Inform @bwilkerson of any issues/changes you had to make.

  6. Once the file is ready, create a PR ~that references the version of the diagnostics.md file~.

Thinking about how to automate this, I'm not positive it should be automated, but perhaps it'd be good to have a build check (failable) about whether this file should be updated.

Yes, that is what I had in mind; similar to what we do with the code-excerpt refresh. I.e., actual code refresh is under site-maintainer control (and done manually using a single command), but the build scripts ensure that everything is up-to-date.

Was this page helpful?
0 / 5 - 0 ratings

Related issues

kwalrath picture kwalrath  路  3Comments

miquelbeltran picture miquelbeltran  路  5Comments

tehsphinx picture tehsphinx  路  3Comments

feinstein picture feinstein  路  4Comments

feinstein picture feinstein  路  4Comments