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 a workflow to deply the markdown playground #1966

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

devoncarew
Copy link
Member

This deploys the markdown playground to https://dart-lang.github.io/tools on pushes to main, and tests that the app builds on every PR.

I may follow this up with a change that instead deploys to https://dart-lang.github.io/tools/markdown / https://dart-lang.github.io/tools/markdown_playground (or, happy to do that as part of this PR).


  • I’ve reviewed the contributor guide and applied the relevant portions to this PR.
Contribution guidelines:

Note that many Dart repos have a weekly cadence for reviewing PRs - please allow for some latency before initial review feedback.

@github-actions github-actions bot added type-infra A repository infrastructure change or enhancement package:markdown labels Jan 14, 2025
Copy link

github-actions bot commented Jan 14, 2025

PR Health

Breaking changes ✔️
Package Change Current Version New Version Needed Version Looking good?
markdown None 7.3.0 7.3.1-wip 7.3.0 ✔️
Changelog Entry ✔️
Package Changed Files

Changes to files need to be accounted for in their respective changelogs.

Coverage ⚠️
File Coverage
pkgs/markdown/lib/src/version.dart 💔 Not covered

This check for test coverage is informational (issues shown here will not fail the PR).

This check can be disabled by tagging the PR with skip-coverage-check.

API leaks ✔️

The following packages contain symbols visible in the public API, but not exported by the library. Export these symbols or remove them from your publicly visible API.

Package Leaked API symbols
License Headers ✔️
// Copyright (c) 2025, the Dart project authors. Please see the AUTHORS file
// for details. All rights reserved. Use of this source code is governed by a
// BSD-style license that can be found in the LICENSE file.
Files
no missing headers

All source files should start with a license header.

Unrelated files missing license headers
Files
pkgs/bazel_worker/benchmark/benchmark.dart
pkgs/bazel_worker/example/client.dart
pkgs/bazel_worker/example/worker.dart
pkgs/benchmark_harness/integration_test/perf_benchmark_test.dart
pkgs/boolean_selector/example/example.dart
pkgs/clock/lib/clock.dart
pkgs/clock/lib/src/clock.dart
pkgs/clock/lib/src/default.dart
pkgs/clock/lib/src/stopwatch.dart
pkgs/clock/lib/src/utils.dart
pkgs/clock/test/clock_test.dart
pkgs/clock/test/default_test.dart
pkgs/clock/test/stopwatch_test.dart
pkgs/clock/test/utils.dart
pkgs/html/example/main.dart
pkgs/html/lib/dom.dart
pkgs/html/lib/dom_parsing.dart
pkgs/html/lib/html_escape.dart
pkgs/html/lib/parser.dart
pkgs/html/lib/src/constants.dart
pkgs/html/lib/src/encoding_parser.dart
pkgs/html/lib/src/html_input_stream.dart
pkgs/html/lib/src/list_proxy.dart
pkgs/html/lib/src/query_selector.dart
pkgs/html/lib/src/token.dart
pkgs/html/lib/src/tokenizer.dart
pkgs/html/lib/src/treebuilder.dart
pkgs/html/lib/src/utils.dart
pkgs/html/test/dom_test.dart
pkgs/html/test/parser_feature_test.dart
pkgs/html/test/parser_test.dart
pkgs/html/test/query_selector_test.dart
pkgs/html/test/selectors/level1_baseline_test.dart
pkgs/html/test/selectors/level1_lib.dart
pkgs/html/test/selectors/selectors.dart
pkgs/html/test/support.dart
pkgs/html/test/tokenizer_test.dart
pkgs/pubspec_parse/test/git_uri_test.dart
pkgs/stack_trace/example/example.dart
pkgs/watcher/test/custom_watcher_factory_test.dart
pkgs/yaml_edit/example/example.dart

## 7.3.1-wip

* Update the README link to the markdown playground
(https://dart-lang.github.io/tools).
Copy link
Member

Choose a reason for hiding this comment

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

We should get a redirect in the old place, too.

https://github.com/dart-archive/dart-lang.github.io is how you do it. Not sure why it was archived.

Copy link
Member Author

Choose a reason for hiding this comment

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

You probably mean https://github.com/dart-lang/markdown (the archived repo above was for package:io).

+1 to a re-direct.

Copy link
Member

Choose a reason for hiding this comment

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

I DON'T! You can put anything in dart-lang.github.io/XYZ. Even /markdown if the repo isn't there.

@kevmoo
Copy link
Member

kevmoo commented Jan 14, 2025

/tools/markdown is probably better. Clear URIs and namespacing: good.

Copy link
Member

@srawlins srawlins left a comment

Choose a reason for hiding this comment

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

Lovely!

@@ -9,10 +9,12 @@ on:
branches: [ main ]
paths:
- '.github/workflows/markdown_crash_test.yaml'
- 'pkgs/markdown/**'
Copy link
Member

Choose a reason for hiding this comment

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

In the previous PR, I didn't put in the filter on all markdown files, as this test is kind of slow. It used to run only periodically in the old repo, and I switched it to run on changes to the workflow itself. I am fine with always running it, just something to be aware of. I also may be vastly wrong about the running time...

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
package:markdown type-infra A repository infrastructure change or enhancement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Recreate dart-lang.github.io/markdown
4 participants