Skip to content

fix: Add missing license headers to Docs - #6958

Merged
xuang7 merged 2 commits into
apache:mainfrom
parshimers:imaxon/mdheaders
Jul 28, 2026
Merged

fix: Add missing license headers to Docs#6958
xuang7 merged 2 commits into
apache:mainfrom
parshimers:imaxon/mdheaders

Conversation

@parshimers

@parshimers parshimers commented Jul 28, 2026

Copy link
Copy Markdown
Member

What changes were proposed in this PR?

This just adds missing license headers to the markdown documentation and other markdown files in the source. It also enables checking of markdown files for these headers via skywalking eyes by changing the .licenserc config.

Performance Impact

None- these are headers in doc files.

Any related issues, documentation, discussions?

Closes #6955
Would be a follow on to the inital addition of license headers to other source files, e.g. #3415 and #4135

related vote thread: https://lists.apache.org/thread/x12wsodfyhqs1fxr95fw6ngyw1xxn5jk

How was this PR tested?

If the CI check passes it should be fine. I only allowed one file which I think is not under ASL2, but mentioned elsewhere

Was this PR authored or co-authored using generative AI tooling?

No.

@github-actions

Copy link
Copy Markdown
Contributor

👋 Thanks for your first contribution to Texera, @parshimers!

If you're looking for a good place to start, browse issues labeled starter-task; they're scoped to be approachable for newcomers.

You can drive common housekeeping yourself by commenting one of these commands on its own line:

  • Issues. Comment /take to assign an open issue to yourself, or /untake to release it. You can find unclaimed work with the search filter is:issue is:open no:assignee.
  • Sub-issues. To link issues into a parent/child hierarchy, comment /sub-issue #5166 #5222 on the parent to attach those children (or /unsub-issue #5166 #5222 to detach them). From a child issue, comment /parent-issue #5166 to set its parent, or /unparent-issue to clear it (the current parent is detected automatically). References may be written as #5166 or as a bare 5166; cross-repository references are not supported.
  • Pull requests (author only). Comment /request-review @user to request a review from someone, or /unrequest-review @user to withdraw that request.

Each command must match exactly: /take this will not work, only /take does. For the full contribution flow, see CONTRIBUTING.md.

@Yicong-Huang Yicong-Huang added the release/v1.2 back porting to release/v1.2 label Jul 28, 2026
@github-actions github-actions Bot added frontend Changes related to the frontend GUI ci changes related to CI docs Changes related to documentations infra pyright-language-service Changes under pyright-language-service/ (Pyright LSP bridge) and removed release/v1.2 back porting to release/v1.2 labels Jul 28, 2026
@Yicong-Huang
Yicong-Huang requested a review from xuang7 July 28, 2026 00:04
@github-actions

Copy link
Copy Markdown
Contributor

Automated Reviewer Suggestions

Based on the git blame history of the changed files, we recommend the following reviewers:

  • Contributors with relevant context: @Ma77Ball, @Yicong-Huang, @aglinxinyuan
    You can notify them by mentioning @Ma77Ball, @Yicong-Huang, @aglinxinyuan in a comment.

@codecov-commenter

codecov-commenter commented Jul 28, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 78.96%. Comparing base (bfe2b53) to head (09a7cb5).

Additional details and impacted files
@@             Coverage Diff              @@
##               main    #6958      +/-   ##
============================================
- Coverage     78.99%   78.96%   -0.03%     
+ Complexity     3789     3781       -8     
============================================
  Files          1160     1160              
  Lines         46105    46105              
  Branches       5115     5115              
============================================
- Hits          36420    36409      -11     
- Misses         8067     8072       +5     
- Partials       1618     1624       +6     
Flag Coverage Δ
access-control-service 70.00% <ø> (ø)
agent-service 76.76% <ø> (ø)
amber 72.14% <ø> (-0.07%) ⬇️
computing-unit-managing-service 20.49% <ø> (ø)
config-service 66.66% <ø> (ø)
file-service 67.21% <ø> (ø)
frontend 82.99% <ø> (ø)
notebook-migration-service 78.94% <ø> (ø)
pyamber 95.38% <ø> (ø)
workflow-compiling-service 26.31% <ø> (ø)

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@github-actions

github-actions Bot commented Jul 28, 2026

Copy link
Copy Markdown
Contributor

⚠️ Benchmark changes need a look

🟢 0 better · 🔴 9 worse · ⚪ 6 noise (<±5%) · 0 without baseline

Compared against main bfe2b53 benchmarked on this same runner, so the delta is largely free of cross-runner hardware noise. The "7d avg" column still reflects the gh-pages dashboard. Treat <±5% as noise unless repeated.

Dashboard · Run

config throughput MB/s latency max Δ latest / 7d
🔴 bs=10 sw=10 sl=64 430 0.262 22,835/31,887/31,887 us 🔴 -5.4% / 🔴 +101.8%
🔴 bs=100 sw=10 sl=64 922 0.563 107,229/140,615/140,615 us 🔴 +15.2% / 🔴 +31.0%
🔴 bs=1000 sw=10 sl=64 1,079 0.658 927,561/1,042,447/1,042,447 us 🔴 +9.0% / 🟢 -5.5%
Baseline details

Latest main bfe2b53 from same runner

config metric PR latest main 7d avg Δ latest Δ 7d
bs=10 sw=10 sl=64 throughput 430 tuples/sec 453 tuples/sec 787.55 tuples/sec -5.1% -45.4%
bs=10 sw=10 sl=64 MB/s 0.262 MB/s 0.277 MB/s 0.481 MB/s -5.4% -45.5%
bs=10 sw=10 sl=64 p50 22,835 us 23,008 us 12,255 us -0.8% +86.3%
bs=10 sw=10 sl=64 p95 31,887 us 32,114 us 15,802 us -0.7% +101.8%
bs=10 sw=10 sl=64 p99 31,887 us 32,114 us 19,008 us -0.7% +67.8%
bs=100 sw=10 sl=64 throughput 922 tuples/sec 977 tuples/sec 997.81 tuples/sec -5.6% -7.6%
bs=100 sw=10 sl=64 MB/s 0.563 MB/s 0.597 MB/s 0.609 MB/s -5.7% -7.6%
bs=100 sw=10 sl=64 p50 107,229 us 99,749 us 100,690 us +7.5% +6.5%
bs=100 sw=10 sl=64 p95 140,615 us 122,045 us 107,316 us +15.2% +31.0%
bs=100 sw=10 sl=64 p99 140,615 us 122,045 us 113,823 us +15.2% +23.5%
bs=1000 sw=10 sl=64 throughput 1,079 tuples/sec 1,108 tuples/sec 1,030 tuples/sec -2.6% +4.7%
bs=1000 sw=10 sl=64 MB/s 0.658 MB/s 0.676 MB/s 0.629 MB/s -2.7% +4.6%
bs=1000 sw=10 sl=64 p50 927,561 us 897,899 us 981,213 us +3.3% -5.5%
bs=1000 sw=10 sl=64 p95 1,042,447 us 956,493 us 1,027,605 us +9.0% +1.4%
bs=1000 sw=10 sl=64 p99 1,042,447 us 956,493 us 1,055,466 us +9.0% -1.2%
Raw CSV
config_idx,batch_size,schema_width,string_len,num_batches,total_ms,total_tuples,total_bytes,tuples_per_sec,mb_per_sec,lat_p50_us,lat_p95_us,lat_p99_us
0,10,10,64,20,465.58,200,128000,430,0.262,22834.89,31886.59,31886.59
1,100,10,64,20,2168.65,2000,1280000,922,0.563,107228.71,140615.08,140615.08
2,1000,10,64,20,18543.94,20000,12800000,1079,0.658,927561.20,1042446.73,1042446.73

@Yicong-Huang Yicong-Huang changed the title fix: Add missing license headers to Docs (#6955) fix: Add missing license headers to Docs Jul 28, 2026
@github-actions github-actions Bot removed the ci changes related to CI label Jul 28, 2026
@parshimers

Copy link
Copy Markdown
Member Author

I'm a little confused about how https://github.com/apache/incubator-texera-site and the content under docs/ interact. Is the content under docs/ just a copy that is never published to https://texera.apache.org/docs/latest/ ? Or is there some way the content will be copied/referenced at a tagged version for each release or something along those lines?
The reason I ask is I'd like to be sure the way the license headers are added doesn't make anything that ends up parsing the markdown break. AFAIK there's no universally accepted way of adding comments to markdown itself. Certainly if it's going to be rendered into a page HTML seems like a sensible option but I don't know that this is always the case.

@Yicong-Huang

Copy link
Copy Markdown
Contributor

Thanks @parshimers for the question. @Ma77Ball please explain the current doc setup and the plan forward.

@Yicong-Huang Yicong-Huang left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @parshimers for the fix! Added two comments inline.

Comment thread .licenserc.yaml Outdated
Comment thread .licenserc.yaml Outdated

@xuang7 xuang7 left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The PR looks good to me. Thanks for the fix! Once it is ready to merge, we can backport it to the release/v1.2 branch.

@xuang7 xuang7 added the release/v1.2 back porting to release/v1.2 label Jul 28, 2026
 ### What changes were proposed in this PR?
 This just adds missing license headers to the markdown documentation and other
 markdown files in the source. It also enables checking of markdown files for
 these headers via skywalking eyes by changing the .licenserc config.

 ### Performance Impact
 None- these are headers in doc files.

 ### Any related issues, documentation, discussions?

 Closes apache#6955
 Would be a follow on to the inital addition of license headers to other source
 files, e.g. apache#3415
 and apache#4135

 related vote thread: https://lists.apache.org/thread/x12wsodfyhqs1fxr95fw6ngyw1xxn5jk

 ### How was this PR tested?
 I ran skywalking-eyes header check locally.

 ### Was this PR authored or co-authored using generative AI tooling?
 No.
@parshimers

Copy link
Copy Markdown
Member Author

The PR looks good to me. Thanks for the fix! Once it is ready to merge, we can backport it to the release/v1.2 branch.

Sounds good. I can also move it to a more appropriate branch if that makes things cleaner. Do sbt releases work kind of like maven-release-plugin ones, where you merge back in the release branch to advance the version? Or does the RC branch basically just become the release branch and never gets merged back?

@Yicong-Huang

Copy link
Copy Markdown
Contributor

@parshimers we don't do sbt/maven release for texera. We release the docker images instead. But the merging processing is similar: we merge to main then backport to release branches like release/v1.2, and the next RC will cut from the release branch.

We are also ongoing automatic backport CI changes in the recent 1~2 days, you will see automations to help you backport with simply adding the release/v1.2 label on this PR targeting main. If the auto backport fails (e.g., due to conflict or failed CI), a backport PR targeting the release branch will be opened so you can resolve the issue and merge there.

@parshimers
parshimers marked this pull request as ready for review July 28, 2026 22:03
@github-actions github-actions Bot added the ci changes related to CI label Jul 28, 2026
@xuang7
xuang7 added this pull request to the merge queue Jul 28, 2026
Merged via the queue into apache:main with commit 214402f Jul 28, 2026
38 checks passed
@github-actions

Copy link
Copy Markdown
Contributor

Backport PR opened: draft #6982 (#6982) to release/v1.2, assigned to @parshimers — needs manual work because the cherry-pick conflicts.

Yicong-Huang added a commit that referenced this pull request Jul 29, 2026
Keep the release/v1.2 title (# Texera Deployment) and add the ASF
license header from #6958. bin/local-dev/README.md was already resolved.
Yicong-Huang added a commit that referenced this pull request Jul 29, 2026
This v1.2-only doc was missing a header; the markdown header check
enabled by #6958 flagged it (invalid: 1). Header placed before the
front matter, matching docs/tutorials/_index.md.
Yicong-Huang added a commit that referenced this pull request Jul 29, 2026
### What changes were proposed in this PR?
This just adds missing license headers to the markdown documentation and
other markdown files in the source. It also enables checking of markdown
files for these headers via skywalking eyes by changing the .licenserc
config.

### Performance Impact
None- these are headers in doc files.

### Any related issues, documentation, discussions?

Closes #6955
Would be a follow on to the inital addition of license headers to other
source files, e.g. #3415 and
#4135

related vote thread:
https://lists.apache.org/thread/x12wsodfyhqs1fxr95fw6ngyw1xxn5jk

### How was this PR tested?
If the CI check passes it should be fine. I only allowed one file which
I think is not under ASL2, but mentioned elsewhere

### Was this PR authored or co-authored using generative AI tooling?
No.

(backported from commit 214402f)

Co-authored-by: Yicong Huang <17627829+Yicong-Huang@users.noreply.github.com>
Yicong-Huang added a commit that referenced this pull request Jul 29, 2026
Keep the release/v1.2 title (# Texera Deployment) and add the ASF
license header from #6958. bin/local-dev/README.md was already resolved.
Yicong-Huang added a commit that referenced this pull request Jul 29, 2026
This v1.2-only doc was missing a header; the markdown header check
enabled by #6958 flagged it (invalid: 1). Header placed before the
front matter, matching docs/tutorials/_index.md.
xuang7 pushed a commit that referenced this pull request Jul 29, 2026
### What changes were proposed in this PR?

Automated backport of #6958 to `release/v1.2`.

Source: 214402f · [automation
run](https://github.com/apache/texera/actions/runs/30409320142)

### Any related issues, documentation, discussions?

Backport of #6958. Originally linked #6955.
https://lists.apache.org/thread/x12wsodfyhqs1fxr95fw6ngyw1xxn5jk

### How was this PR tested?

Release-branch CI runs on this branch once the conflicts are resolved
and this PR is marked ready for review.

### Was this PR authored or co-authored using generative AI tooling?

No.

---------

Co-authored-by: Ian Maxon <parshimers@gmail.com>
Co-authored-by: Yicong Huang <17627829+Yicong-Huang@users.noreply.github.com>
renovate-bot pushed a commit to renovate-bot/apache-_-texera that referenced this pull request Jul 29, 2026
…pache#7022)

### What changes were proposed in this PR?

The `Report backport decisions` step in `backport-auto-label.yml` is
skipped on every run, so the report comment and release-manager review
request added in apache#6962 never fire.

Root cause: the step's guard reads `steps.label.outputs.result`.
`actions/github-script` always writes the script's return value to an
output named `result` after the body runs. The `Label fix PRs` script
has no `return`, so that post-run write blanks out the explicit
`core.setOutput("result", …)` — the guard is therefore always false.

Fix: rename the output to `decisions` (github-script only reserves
`result`), and update the guard and the `RESULT` env reference to match.
No logic in either step changes.

### Any related issues, documentation, discussions?

Closes apache#7021.

### How was this PR tested?

- Confirmed the failure on run `30423275226` (PR apache#7013): the `Report
backport decisions` step shows `skipped`.
- Verified 0 `<!-- backport-auto-label-report -->` comments across
apache#7013, apache#6983, apache#6958, apache#6908 (including PRs that were auto-labeled),
confirming the step is systemically skipped.
- Change is name-only; the report/review logic is untouched, so it runs
unchanged once the guard sees the output.

### Was this PR authored or co-authored using generative AI tooling?

Generated-by: Claude Code (Claude Opus 4.8)

Co-authored-by: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ci changes related to CI docs Changes related to documentations frontend Changes related to the frontend GUI infra pyright-language-service Changes under pyright-language-service/ (Pyright LSP bridge) release/v1.2 back porting to release/v1.2

Projects

None yet

Development

Successfully merging this pull request may close these issues.

License headers are missing for docs and other .md files

4 participants