From cc1340663fd41c833b08fa0139310ee166bbf1a7 Mon Sep 17 00:00:00 2001 From: Josh Soref Date: Sun, 6 Jun 2021 19:53:25 -0400 Subject: [PATCH 01/34] spelling: exclude Signed-off-by: Josh Soref --- test/markups/README.org | 2 +- test/markups/README.org.html | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/test/markups/README.org b/test/markups/README.org index dded60e3..0eca800a 100644 --- a/test/markups/README.org +++ b/test/markups/README.org @@ -58,7 +58,7 @@ end - Skipping text before the first headline (option skip:t) - Skipping tables (option |:nil) - Custom todo keywords - - EXPORT_SELECT_TAGS and EXPORT_EXLUDE_TAGS for controlling parts of + - EXPORT_SELECT_TAGS and EXPORT_EXCLUDE_TAGS for controlling parts of the tree to export - Rewrite "file:(blah).org" links to "http:(blah).html" links. This makes the inter-links to other org-mode files work. diff --git a/test/markups/README.org.html b/test/markups/README.org.html index ddf8b27e..458024af 100644 --- a/test/markups/README.org.html +++ b/test/markups/README.org.html @@ -52,7 +52,7 @@

2.3 2009-12-30: Version 0.5.0

  • Skipping text before the first headline (option skip:t)
  • Skipping tables (option |:nil)
  • Custom todo keywords
  • -
  • EXPORT_SELECT_TAGS and EXPORT_EXLUDE_TAGS for controlling parts of +
  • EXPORT_SELECT_TAGS and EXPORT_EXCLUDE_TAGS for controlling parts of the tree to export
  • From c806bbfb3f02b0203bc91633b75399eb5e0cf3c4 Mon Sep 17 00:00:00 2001 From: Nick Borromeo Date: Mon, 7 Mar 2022 19:12:02 -0800 Subject: [PATCH 02/34] Bump commonmark version --- Gemfile | 2 +- HISTORY.md | 3 +++ lib/github-markup.rb | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/Gemfile b/Gemfile index 61920ab8..c38f68e8 100644 --- a/Gemfile +++ b/Gemfile @@ -5,7 +5,7 @@ gem "posix-spawn", :platforms => :ruby gem "redcarpet", :platforms => :ruby gem "kramdown", :platforms => :jruby gem "RedCloth" -gem "commonmarker", "~> 0.18.1" +gem "commonmarker", "~> 0.23.4" gem "rdoc", "~>3.6" gem "org-ruby", "= 0.9.9" gem "creole", "~>0.3.6" diff --git a/HISTORY.md b/HISTORY.md index c296602b..966ef18c 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,3 +1,6 @@ +## 4.0.1 - 2022-03-07 +* Update to commonmarker 0.23.4; See [Version Changelog](https://github.com/gjtorikian/commonmarker/blob/main/CHANGELOG.md#v0234-2022-03-03) + ## 4.0.0 - 2021-03-31 * Drop support for Python 2 in RST rendering [#1456](https://github.com/github/markup/pull/1456) diff --git a/lib/github-markup.rb b/lib/github-markup.rb index df6aa41d..0244f156 100644 --- a/lib/github-markup.rb +++ b/lib/github-markup.rb @@ -1,6 +1,6 @@ module GitHub module Markup - VERSION = '4.0.0' + VERSION = '4.0.1' Version = VERSION end end From d35c00f367036effadab9cc7b6022b4cecbe1754 Mon Sep 17 00:00:00 2001 From: Nick Borromeo Date: Mon, 7 Mar 2022 19:12:02 -0800 Subject: [PATCH 03/34] Bump commonmark version --- Gemfile | 2 +- HISTORY.md | 3 +++ lib/github-markup.rb | 2 +- 3 files changed, 5 insertions(+), 2 deletions(-) diff --git a/Gemfile b/Gemfile index 61920ab8..7067b704 100644 --- a/Gemfile +++ b/Gemfile @@ -5,7 +5,7 @@ gem "posix-spawn", :platforms => :ruby gem "redcarpet", :platforms => :ruby gem "kramdown", :platforms => :jruby gem "RedCloth" -gem "commonmarker", "~> 0.18.1" +gem "commonmarker", git: "https://github.com/gjtorikian/commonmarker.git", tag: "v0.18.3" gem "rdoc", "~>3.6" gem "org-ruby", "= 0.9.9" gem "creole", "~>0.3.6" diff --git a/HISTORY.md b/HISTORY.md index c296602b..966ef18c 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,3 +1,6 @@ +## 4.0.1 - 2022-03-07 +* Update to commonmarker 0.23.4; See [Version Changelog](https://github.com/gjtorikian/commonmarker/blob/main/CHANGELOG.md#v0234-2022-03-03) + ## 4.0.0 - 2021-03-31 * Drop support for Python 2 in RST rendering [#1456](https://github.com/github/markup/pull/1456) diff --git a/lib/github-markup.rb b/lib/github-markup.rb index df6aa41d..0244f156 100644 --- a/lib/github-markup.rb +++ b/lib/github-markup.rb @@ -1,6 +1,6 @@ module GitHub module Markup - VERSION = '4.0.0' + VERSION = '4.0.1' Version = VERSION end end From 2de4aa63c419d1cc111e01e1678caf127f0a2356 Mon Sep 17 00:00:00 2001 From: Aaron Harpole Date: Mon, 14 Mar 2022 22:10:11 +0000 Subject: [PATCH 04/34] fix some minor changes in the generated HTML --- test/markups/README.rst.html | 8 +++----- 1 file changed, 3 insertions(+), 5 deletions(-) diff --git a/test/markups/README.rst.html b/test/markups/README.rst.html index 3ddfab76..6accfdf6 100644 --- a/test/markups/README.rst.html +++ b/test/markups/README.rst.html @@ -9,7 +9,7 @@

    Subtitle

    -

    Header 2

    +

    Header 2

    1. Blah blah code blah
    2. More code, hooray
    3. @@ -106,7 +106,7 @@

      Header 2

      Coverity Scan Build Status -

      Field list

      +

      Field list

      @@ -131,9 +131,7 @@

      Field list

      -

      someone@somewhere.org

      -

      Press Ctrl+C to quit

      -

      RAW HTML!

      p {color:blue;} +

      RAW HTML!

      p {color:blue;} \ No newline at end of file From 4dc7c5612759fc9ce63a7af8bac38f72fc7e1de2 Mon Sep 17 00:00:00 2001 From: Aaron Harpole Date: Mon, 21 Mar 2022 15:41:09 -0700 Subject: [PATCH 05/34] Update HISTORY.md Co-authored-by: Nick Borromeo --- HISTORY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/HISTORY.md b/HISTORY.md index 966ef18c..51f16dfc 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,5 +1,5 @@ ## 4.0.1 - 2022-03-07 -* Update to commonmarker 0.23.4; See [Version Changelog](https://github.com/gjtorikian/commonmarker/blob/main/CHANGELOG.md#v0234-2022-03-03) +* Update to commonmarker 0.18.3; There isn't a version on RubyGems for this, so this is pointing to a [tag version on GitHub](https://github.com/gjtorikian/commonmarker/blob/v0.18.3/commonmarker.gemspec) ## 4.0.0 - 2021-03-31 From 040f91d9919c51a5ecbe54352a207a3281f07359 Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Tue, 12 Apr 2022 07:20:31 +0200 Subject: [PATCH 06/34] Make sure all anchors are created for RST links. --- lib/github/commands/rest2html | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/lib/github/commands/rest2html b/lib/github/commands/rest2html index c7c89dce..c6fc663e 100755 --- a/lib/github/commands/rest2html +++ b/lib/github/commands/rest2html @@ -199,8 +199,8 @@ class GitHubHTMLTranslator(HTMLTranslator): # see also: http://bit.ly/NHtyRx # the a is to support ::contents with ::sectnums: http://git.io/N1yC def visit_section(self, node): - id_attribute = node.attributes['ids'][0] - self.body.append('\n' % id_attribute) + for id_attribute in node.attributes['ids']: + self.body.append('\n' % id_attribute) self.section_level += 1 def depart_section(self, node): From a78c9a718bf64daeb6cf2f996c5844fa7fc3457f Mon Sep 17 00:00:00 2001 From: Felix Fontein Date: Tue, 12 Apr 2022 07:28:04 +0200 Subject: [PATCH 07/34] Add test. On my system rest2html generates quite some different markup so I'm not sure whether this actually works. --- test/markups/README.rst | 4 ++++ test/markups/README.rst.html | 2 ++ 2 files changed, 6 insertions(+) diff --git a/test/markups/README.rst b/test/markups/README.rst index 53cba9e0..ad7af380 100644 --- a/test/markups/README.rst +++ b/test/markups/README.rst @@ -8,6 +8,8 @@ Example text. .. contents:: Table of Contents +.. _label_for_header_2: + Header 2 -------- @@ -17,6 +19,8 @@ Header 2 3. Somé UTF-8° +4. `Link to the above header `_ + The UTF-8 quote character in this table used to cause python to go boom. Now docutils just silently ignores it. .. csv-table:: Things that are Awesome (on a scale of 1-11) diff --git a/test/markups/README.rst.html b/test/markups/README.rst.html index 6accfdf6..ca6807f8 100644 --- a/test/markups/README.rst.html +++ b/test/markups/README.rst.html @@ -9,11 +9,13 @@

      Subtitle

      +

      Header 2

      1. Blah blah code blah
      2. More code, hooray
      3. Somé UTF-8°
      4. +
      5. Link to the above header

      The UTF-8 quote character in this table used to cause python to go boom. Now docutils just silently ignores it.

      From e935a8505554aa175e9af89f1670d2dd5d03c469 Mon Sep 17 00:00:00 2001 From: djdefi Date: Thu, 29 Dec 2022 11:30:34 -0800 Subject: [PATCH 08/34] Remove reference to deprecated support email --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f6a81e94..2c83e31e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,7 +11,7 @@ This library's only job is to decide which markup format to use and call out to If you are having an issue with: * **Syntax highlighting** - see [github/linguist](https://github.com/github/linguist/blob/master/CONTRIBUTING.md#fixing-syntax-highlighting) -* **Markdown on GitHub** - contact support@github.com +* **Markdown on GitHub** - contact [GitHub Support](https://support.github.com/) * **Styling issues on GitHub** - see [primer-markdown](https://github.com/primer/primer-css/tree/master/modules/primer-markdown) module in the [primer/primer-css](https://github.com/primer/primer-css) repository Anything else - [search open issues](https://github.com/github/markup/issues) or create an issue and and we'll help point you in the right direction. From 65bfe283658857d7d506c923bd808c369a8cd90d Mon Sep 17 00:00:00 2001 From: TAbdiukov Date: Tue, 4 Jul 2023 06:23:18 +0200 Subject: [PATCH 09/34] Textile language link now leads to something completely different - replace the link with the current official one --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index b2bcc809..93eb15ba 100644 --- a/README.md +++ b/README.md @@ -20,7 +20,7 @@ The following markups are supported. The dependencies listed are required if you wish to run the library. You can also run `script/bootstrap` to fetch them all. * [.markdown, .mdown, .mkdn, .md](http://daringfireball.net/projects/markdown/) -- `gem install commonmarker` (https://github.com/gjtorikian/commonmarker) -* [.textile](https://www.promptworks.com/textile) -- `gem install RedCloth` (https://github.com/jgarber/redcloth) +* [.textile](https://textile-lang.com/) -- `gem install RedCloth` (https://github.com/jgarber/redcloth) * [.rdoc](https://ruby.github.io/rdoc/) -- `gem install rdoc -v 3.6.1` * [.org](http://orgmode.org/) -- `gem install org-ruby` (https://github.com/wallyqs/org-ruby) * [.creole](http://wikicreole.org/) -- `gem install creole` (https://github.com/larsch/creole) From 04873413c9f1df24d3e7d54cfb3fbb830df76076 Mon Sep 17 00:00:00 2001 From: Chris Maynard Date: Tue, 10 Oct 2023 14:58:28 -0700 Subject: [PATCH 10/34] Add markdown support for .mdx files --- HISTORY.md | 3 +++ lib/github-markup.rb | 2 +- lib/github/markup/markdown.rb | 4 ++-- 3 files changed, 6 insertions(+), 3 deletions(-) diff --git a/HISTORY.md b/HISTORY.md index 51f16dfc..57145177 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,3 +1,6 @@ +## 4.0.2 - 2023-10-10 +* Add support for .mdx files in markdown + ## 4.0.1 - 2022-03-07 * Update to commonmarker 0.18.3; There isn't a version on RubyGems for this, so this is pointing to a [tag version on GitHub](https://github.com/gjtorikian/commonmarker/blob/v0.18.3/commonmarker.gemspec) diff --git a/lib/github-markup.rb b/lib/github-markup.rb index 0244f156..58f9b1c5 100644 --- a/lib/github-markup.rb +++ b/lib/github-markup.rb @@ -1,6 +1,6 @@ module GitHub module Markup - VERSION = '4.0.1' + VERSION = '4.0.2' Version = VERSION end end diff --git a/lib/github/markup/markdown.rb b/lib/github/markup/markdown.rb index 7952bd3b..dcf93229 100644 --- a/lib/github/markup/markdown.rb +++ b/lib/github/markup/markdown.rb @@ -31,8 +31,8 @@ class Markdown < Implementation def initialize super( - /md|mkdn?|mdwn|mdown|markdown|litcoffee/i, - ["Markdown", "Literate CoffeeScript"]) + /md|mkdn?|mdwn|mdown|markdown|mdx|litcoffee/i, + ["Markdown", "MDX", "Literate CoffeeScript"]) end def load From 5488510af8644f45e9caa20ec00b6a0d10955517 Mon Sep 17 00:00:00 2001 From: Justin Kenyon Date: Wed, 12 Jun 2024 15:46:50 -0400 Subject: [PATCH 11/34] Update nokogiri, nokogiri-diff, rdoc This also removes support for Ruby versions < 3 Brings in changes from https://github.com/github/markup/pull/1808 co-authored-by: Tyler Dixon --- .github/workflows/ci.yml | 8 +- .gitignore | 3 +- Gemfile | 4 +- HISTORY.md | 7 + github-markup.gemspec | 7 +- lib/github-markup.rb | 2 +- lib/github/markup/command_implementation.rb | 36 +- test/markup_test.rb | 7 +- test/markups/README.asciidoc.html | 2 +- test/markups/README.hidetitle.asciidoc.html | 2 +- test/markups/README.litcoffee.html | 2 +- test/markups/README.long.rst | 1319 +++++++++++++++++++ test/markups/README.long.rst.html | 1303 ++++++++++++++++++ test/markups/README.mediawiki.html | 14 +- test/markups/README.pod.html | 12 +- test/markups/README.rst.html | 8 +- test/markups/README.toc.asciidoc.html | 2 +- test/markups/README.toc.rst.html | 4 +- 18 files changed, 2683 insertions(+), 59 deletions(-) create mode 100644 test/markups/README.long.rst create mode 100644 test/markups/README.long.rst.html diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 52d4db54..a25fdefc 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -11,10 +11,10 @@ jobs: strategy: matrix: ruby: - - "2.4" - - "2.5" - - "2.6" - - "2.7" + - "3.0" + - "3.1" + - "3.2" + - "3.3" fail-fast: false steps: diff --git a/.gitignore b/.gitignore index 589d00dc..c93c0b18 100644 --- a/.gitignore +++ b/.gitignore @@ -4,4 +4,5 @@ pkg/ Gemfile.lock .project .buildpath -*~ +*~ +vendor/ diff --git a/Gemfile b/Gemfile index c98072f2..fb3c1308 100644 --- a/Gemfile +++ b/Gemfile @@ -1,17 +1,17 @@ source "http://rubygems.org" gemspec -gem "posix-spawn", :platforms => :ruby gem "redcarpet", :platforms => :ruby gem "kramdown", :platforms => :jruby gem "RedCloth" # using a tag version here because 0.18.3 was not published by the author to encourage users to upgrade. # however we want to bump up to this version since this has a security patch gem "commonmarker", git: "https://github.com/gjtorikian/commonmarker.git", tag: "v0.18.3" -gem "rdoc", "~>3.6" +gem "rdoc", "~> 6.7.0" gem "org-ruby", "= 0.9.9" gem "creole", "~>0.3.6" gem "wikicloth", "=0.8.3" gem "twitter-text", "~> 1.14" gem "asciidoctor", "~> 2.0.5" gem "rake" +gem "rexml" diff --git a/HISTORY.md b/HISTORY.md index 57145177..ace518d1 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,3 +1,10 @@ +## 5.0.0 - 2024-06-12 +* Drop support for Ruby versions < 3 +* Bump nokogiri from 1.8.1 to 1.16.5 +* Bump nokogiri-diff from 0.2.0 to 0.3.0 +* Bump rdoc from 3.6 to 6.7.0 +* Update CommandImplementation to better support large files (affecting RST and POD6 rendering) + ## 4.0.2 - 2023-10-10 * Add support for .mdx files in markdown diff --git a/github-markup.gemspec b/github-markup.gemspec index 594d3507..4818706d 100644 --- a/github-markup.gemspec +++ b/github-markup.gemspec @@ -13,8 +13,9 @@ Gem::Specification.new do |s| s.homepage = "https://github.com/github/markup" s.license = "MIT" + s.required_ruby_version = '>= 3.0.0' + s.files = `git ls-files`.split($\) - s.files += Dir['vendor/**/*'] s.executables = s.files.grep(%r{^bin/}).map{ |f| File.basename(f) } s.test_files = s.files.grep(%r{^(test|spec|features)/}) s.require_paths = %w[lib] @@ -24,7 +25,7 @@ Gem::Specification.new do |s| s.add_development_dependency 'minitest', '~> 5.4', '>= 5.4.3' s.add_development_dependency 'html-pipeline', '~> 1.0' s.add_development_dependency 'sanitize', '>= 4.6.3' - s.add_development_dependency 'nokogiri', '~> 1.8.1' - s.add_development_dependency 'nokogiri-diff', '~> 0.2.0' + s.add_development_dependency 'nokogiri', '~> 1.16.5' + s.add_development_dependency 'nokogiri-diff', '~> 0.3.0' s.add_development_dependency "github-linguist", ">= 7.1.3" end diff --git a/lib/github-markup.rb b/lib/github-markup.rb index 58f9b1c5..646e341c 100644 --- a/lib/github-markup.rb +++ b/lib/github-markup.rb @@ -1,6 +1,6 @@ module GitHub module Markup - VERSION = '4.0.2' + VERSION = '5.0.0' Version = VERSION end end diff --git a/lib/github/markup/command_implementation.rb b/lib/github/markup/command_implementation.rb index 4ecf2ad5..b55f1735 100644 --- a/lib/github/markup/command_implementation.rb +++ b/lib/github/markup/command_implementation.rb @@ -1,9 +1,4 @@ -begin - require "posix-spawn" -rescue LoadError - require "open3" -end - +require "open3" require "github/markup/implementation" @@ -39,28 +34,13 @@ def call_block(rendered, content) end end - if defined?(POSIX::Spawn) - def execute(command, target) - spawn = POSIX::Spawn::Child.new(*command, :input => target) - if spawn.status.success? - sanitize(spawn.out, target.encoding) - else - raise CommandError.new(spawn.err.strip) - end - end - else - def execute(command, target) - output = Open3.popen3(*command) do |stdin, stdout, stderr, wait_thr| - stdin.puts target - stdin.close - if wait_thr.value.success? - stdout.readlines - else - raise CommandError.new(stderr.readlines.join('').strip) - end - end - sanitize(output.join(''), target.encoding) - end + def execute(command, target) + # capture3 blocks until both buffers are written to and the process terminates, but + # it won't allow either buffer to fill up + stdout, stderr, status = Open3.capture3(*command, stdin_data: target) + + raise CommandError.new(stderr) unless status.success? + sanitize(stdout, target.encoding) end def sanitize(input, encoding) diff --git a/test/markup_test.rb b/test/markup_test.rb index 24e78000..ced0b5f8 100644 --- a/test/markup_test.rb +++ b/test/markup_test.rb @@ -66,6 +66,11 @@ def call f.close_write f.read end + + if ENV['UPDATE'] + File.open(expected_file, 'w') { |f| f.write actual } + end + assert_html_equal expected, actual, < e - assert_equal "failure message", e.message + assert_equal "failure message", e.message.strip else fail "an exception was expected but was not raised" end diff --git a/test/markups/README.asciidoc.html b/test/markups/README.asciidoc.html index 6f478cab..8019074b 100644 --- a/test/markups/README.asciidoc.html +++ b/test/markups/README.asciidoc.html @@ -59,4 +59,4 @@

      Another Section

      content

      - + \ No newline at end of file diff --git a/test/markups/README.hidetitle.asciidoc.html b/test/markups/README.hidetitle.asciidoc.html index ae6b258f..02a55fe7 100644 --- a/test/markups/README.hidetitle.asciidoc.html +++ b/test/markups/README.hidetitle.asciidoc.html @@ -1,3 +1,3 @@

      This test verifies the author can disable the document title by adding :!showtitle: to the document header.

      -
      + \ No newline at end of file diff --git a/test/markups/README.litcoffee.html b/test/markups/README.litcoffee.html index 51ffe528..3245a0b5 100644 --- a/test/markups/README.litcoffee.html +++ b/test/markups/README.litcoffee.html @@ -52,4 +52,4 @@

      Literate CoffeeScript Test

      Tabs work too:

      test "tabbed code", -> -ok yes

      +ok yes

      \ No newline at end of file diff --git a/test/markups/README.long.rst b/test/markups/README.long.rst new file mode 100644 index 00000000..b1c007a6 --- /dev/null +++ b/test/markups/README.long.rst @@ -0,0 +1,1319 @@ +=================== +Robot Framework 7.0 +=================== + +.. default-role:: code + +`Robot Framework`_ 7.0 is a new major release with highly enhanced listener interface +(`#3296`_), native `VAR` syntax for creating variables (`#3761`_), support for +mixing embedded and normal arguments with library keywords (`#4710`_), JSON +result format (`#4847`_) and various other enhancements and bug fixes. + +Robot Framework 7.0 was released on Thursday January 11, 2024. Questions and comments +related to the release can be sent to the `#devel` channel on `Robot Framework Slack`_ +and possible bugs submitted to the `issue tracker`_. + +.. _Robot Framework: http://robotframework.org +.. _Robot Framework Foundation: http://robotframework.org/foundation + + +.. _pip: http://pip-installer.org +.. _PyPI: https://pypi.python.org/pypi/robotframework +.. _issue tracker milestone: https://github.com/robotframework/robotframework/milestone/64 +.. _issue tracker: https://github.com/robotframework/robotframework/issues +.. _Slack: http://slack.robotframework.org +.. _Robot Framework Slack: Slack_ +.. _installation instructions: ../../INSTALL.rst + +.. contents:: + :depth: 2 + :local: + +Installation +============ + +If you have pip_ installed, just run + +:: + + pip install --upgrade robotframework + +to install the latest available stable release or use + +:: + + pip install robotframework==7.0 + +to install exactly this version. Alternatively you can download the package +from PyPI_ and install it manually. For more details and other installation +approaches, see the `installation instructions`_. + +Most important enhancements +=========================== + + If you are interested to learn more about the new features in Robot Framework 7.0, + join the `RoboCon conference`__ in February, 2024. `Pekka Klärck`_, Robot Framework + lead developer, will go through the key features briefly in the `onsite conference`__ + in Helsinki and more thoroughly in the `online edition`__. + + The conference has also dozens of other great talks, workshops and a lot of + possibilities to meet other community members as well as developers of various + tools and libraries in the ecosystem. All profits from the conference will be + used for future Robot Framework development. + +.. _Pekka Klärck: https://github.com/pekkaklarck +__ https://robocon.io +__ https://robocon.io/#live-opening-the-conference +__ https://robocon.io/#online-opening-the-conference-live + +Listener enhancements +--------------------- + +Robot Framework's `listener interface`__ is a very powerful mechanism to get +notifications about various events during execution and it also allows modifying +data and results on the fly. It is not typically directly used by normal Robot +Framework users, but they are likely to use tools that use it internally. +The listener API has been significantly enhanced making it possible +to create even more powerful and interesting tools in the future. + +__ http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#listener-interface + +Support keywords and control structures with listener version 3 +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The major limitation with the listener API has been that the listener +API version 2 only supports getting notifications, not making modifications, +and that the more powerful listener API version 3 has only supported suites +and tests/tasks. + +The biggest enhancement in the whole Robot Framework 7.0 is that the listener +version 3 has been extended to support also keywords and control structures (`#3296`_). +For example, a listener having the following methods prints information +about started keywords and ended WHILE loops: + +.. code:: python + + from robot import result, running + + + def start_keyword(data: running.Keyword, result: result.Keyword): + print(f"Keyword '{result.full_name}' used on line {data.lineno} started.") + + + def end_while(data: running.While, result: result.While): + print(f"WHILE loop on line {data.lineno} ended with status {result.status} " + f"after {len(result.body)} iterations.") + +With keyword calls it is possible to also get more information about the actually +executed keyword. For example, the following listener prints some information +about the executed keyword and the library it belongs to: + +.. code:: python + + from robot.running import Keyword as KeywordData, LibraryKeyword + from robot.result import Keyword as KeywordResult + + + def start_library_keyword(data: KeywordData, + implementation: LibraryKeyword, + result: KeywordResult): + library = implementation.owner + print(f"Keyword '{implementation.name}' is implemented in library " + f"'{library.name}' at '{implementation.source}' on line " + f"{implementation.lineno}. The library has {library.scope.name} " + f"scope and the current instance is {library.instance}.") + +As the above example already illustrated, it is even possible to get an access to +the actual library instance. This means that listeners can inspect the library +state and also modify it. With user keywords it is even possible to modify +the keyword itself or, via the `owner` resource file, any other keyword in +the resource file. + +Listeners can also modify results if needed. Possible use cases include hiding +sensitive information and adding more details to results based on external sources. + +Notice that although listener can change status of any executed keyword or control +structure, that does not directly affect the status of the executed test. In general +listeners cannot directly fail keywords so that execution would stop or handle +failures so that execution would continue. This kind of functionality may be +added in the future if there are needs. + +The new listener version 3 methods are so powerful and versatile that going them +through thoroughly in these release notes is not possible. For more examples, you +can see the `acceptance tests`__ using the methods in various interesting and even +crazy ways. + +__ https://github.com/robotframework/robotframework/tree/master/atest/testdata/output/listener_interface/body_items_v3 + +Listener version 3 is the default listener version +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Earlier listeners always needed to specify the API version they used with the +`ROBOT_LISTENER_API_VERSION` attribute. Now that the listener version 3 got +the new methods, it is considered so much more powerful than the version 2 +that it was made the default listener version (`#4910`_). + +The listener version 2 continues to work, but using it requires specifying +the listener version as earlier. The are no plans to deprecate the listener +version 2, but we nevertheless highly recommend using the version 3 whenever +possible. + +Libraries can register themselves as listeners by using string `SELF` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Listeners are typically enabled from the command line, but libraries +can register listeners as well. Often libraries themselves want to act +as listeners, and that has earlier required using `self.ROBOT_LIBRARY_LISTENER = self` +in the `__init__` method. Robot Framework 7.0 makes it possible to use string +`SELF` (case-insensitive) for this purpose as well (`#4910`_), which means +that a listener can be specified as a class attribute and not only in `__init__`. +This is especially convenient when using the `@library` decorator: + +.. code:: python + + from robot.api.deco import keyword, library + + + @library(listener='SELF') + class Example: + + def start_suite(self, data, result): + ... + + @keyword + def example(self, arg): + ... + +Nicer API for modifying keyword arguments +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Modifying keyword call arguments programmatically has been made more convenient +(`#5000`_). This enhancement eases modifying arguments using the new listener +version 3 `start/end_keyword` methods. + +Paths are passed to version 3 listeners as `pathlib.Path` objects +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Listeners have methods like `output_file` and `log_file` that are called when +result files are ready so that they get the file path as an argument. Earlier +paths were strings, but nowadays listener version 3 methods get them as +more convenient `pathlib.Path`__ objects. + +__ https://docs.python.org/3/library/pathlib.html + +Native `VAR` syntax +------------------- + +The new `VAR` syntax (`#3761`_) makes it possible to create local variables +as well as global, suite and test/task scoped variables dynamically during +execution. The motivation is to have a more convenient syntax than using +the `Set Variable` keyword for creating local variables and to unify +the syntax for creating variables in different scopes. Except for the mandatory +`VAR` marker, the syntax is also the same as when creating variables in the +Variables section. The syntax is best explained with examples: + +.. code:: robotframework + + *** Test Cases *** + Example + # Create a local variable `${local}` with a value `value`. + VAR ${local} value + + # Create a variable that is available throughout the whole suite. + # Supported scopes are GLOBAL, SUITE, TEST, TASK and LOCAL (default). + VAR ${suite} value scope=SUITE + + # Validate created variables. + Should Be Equal ${local} value + Should Be Equal ${suite} value + + Example continued + # Suite level variables are seen also by subsequent tests. + Should Be Equal ${suite} value + +When creating `${scalar}` variables having long values, it is possible to split +the value to multiple lines. Lines are joined together with a space by default, +but that can be changed with the `separator` configuration option. Similarly as +in the Variables section, it is possible to create also `@{list}` and `&{dict}` +variables. Unlike in the Variables section, variables can be created conditionally +using IF/ELSE structures: + +.. code:: robotframework + + *** Test Cases *** + Long value + VAR ${long} + ... This value is rather long. + ... It has been split to multiple lines. + ... Parts will be joined together with a space. + + Multiline + VAR ${multiline} + ... First line. + ... Second line. + ... Last line. + ... separator=\n + + List + # Creates a list with three items. + VAR @{list} a b c + + Dictionary + # Creates a dictionary with two items. + VAR &{dict} key=value second=item + + Normal IF + IF 1 > 0 + VAR ${x} true value + ELSE + VAR ${x} false value + END + + Inline IF + IF 1 > 0 VAR ${x} true value ELSE VAR ${x} false value + +Mixed argument support with library keywords +-------------------------------------------- + +User keywords got support to use both embedded and normal arguments in Robot +Framework 6.1 (`#4234`__) and now that support has been added also to library keywords +(`#4710`_). The syntax works so, that if a function or method implementing a keyword +accepts more arguments than there are embedded arguments, the remaining arguments +can be passed in as normal arguments. This is illustrated by the following example +keyword: + +.. code:: python + + @keyword('Number of ${animals} should be') + def example(animals, count): + ... + +The above keyword could be used like this: + +.. code:: robotframework + + *** Test Cases *** + Example + Number of horses should be 2 + Number of horses should be count=2 + Number of dogs should be 3 + +__ https://github.com/robotframework/robotframework/issues/4234 + +JSON result format +------------------ + +Robot Framework 6.1 added support to `convert test/task data to JSON and back`__ +and Robot Framework 7.0 extends the JSON serialization support to execution results +(`#4847`_). One of the core use cases for data serialization was making it easy to +transfer data between process and machines, and now it is also easy to pass results +back. + +Also the built-in Rebot tool that is used for post-processing results supports +JSON files both in output and in input. Creating JSON output files is done using +the normal `--output` option so that the specified file has a `.json` extension:: + + rebot --output output.json output.xml + +When reading output files, JSON files are automatically recognized by +the extension:: + + rebot output.json + rebot output1.json output2.json + +When combining or merging results, it is possible to mix JSON and XML files:: + + rebot output1.xml output2.json + rebot --merge original.xml rerun.json + +The JSON output file structure is documented in the `result.json` `schema file`__. + +The plan is to enhance the support for JSON output files in the future so that +they could be created already during execution. For more details see issue `#3423`__. + +__ https://github.com/robotframework/robotframework/blob/master/doc/releasenotes/rf-6.1.rst#json-data-format +__ https://github.com/robotframework/robotframework/tree/master/doc/schema#readme +__ https://github.com/robotframework/robotframework/issues/3423 + +Argument conversion enhancements +-------------------------------- + +Automatic argument conversion is a very powerful feature that library developers +can use to avoid converting arguments manually and to get more useful Libdoc +documentation. There are two important new enhancements to it. + +Support for `Literal` +~~~~~~~~~~~~~~~~~~~~~ + +In Python, the Literal__ type makes it possible to type arguments so that type +checkers accept only certain values. For example, this function only accepts +strings `x`, `y` and `z`: + +.. code:: python + + def example(arg: Literal['x', 'y', 'z']): + ... + +Robot Framework has been enhanced so that it validates that an argument having +a `Literal` type can only be used with the specified values (`#4633`_). For +example, using a keyword with the above implementation with a value `xxx` would +fail. + +In addition to validation, arguments are also converted. For example, if an +argument accepts `Literal[-1, 0, 1]`, used arguments are converted to +integers and then validated. In addition to that, string matching is case, space, +underscore and hyphen insensitive. In all cases exact matches have a precedence +and the argument that is passed to the keyword is guaranteed to be in the exact +format used with `Literal`. + +`Literal` conversion is in many ways similar to Enum__ conversion that Robot +Framework has supported for long time. `Enum` conversion has benefits like +being able to use a custom documentation and it is typically better when using +the same type multiple times. In simple cases being able to just use +`arg: Literal[...]` without defining a new type is very convenient, though. + +__ https://docs.python.org/3/library/typing.html#typing.Literal +__ https://docs.python.org/3/library/enum.html + +Support "stringified" types like `'list[int]'` and `'int | float'` +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +Python's type hinting syntax has evolved so that generic types can be parameterized +like `list[int]` (new in `Python 3.9`__) and unions written as `int | float` +(new in `Python 3.10`__). Using these constructs with older Python versions causes +errors, but Python type checkers support also "stringified" type hints like +`'list[int]'` and `'int | float'` that work regardless the Python version. + +Support for stringified generics and unions has now been added also to +Robot Framework's argument conversion (`#4711`_). For example, +the following typing now also works with Python 3.8: + +.. code:: python + + def example(a: 'list[int]', b: 'int | float'): + ... + +These stringified types are also compatible with the Remote library API and other +scenarios where using actual types is not possible. + +__ https://peps.python.org/pep-0585 +__ https://peps.python.org/pep-0604 + +Tags set globally can be removed using `-tag` syntax +---------------------------------------------------- + +Individual tests and keywords can nowadays remove tags that have been set in +the Settings section with `Test Tags` or `Keyword Tags` settings by using +the `-tag` syntax with their own `[Tags]` setting (`#4374`_). For example, +tests `T1` and `T3` below get tags `all` and `most`, and test `T2` gets +tags `all` and `one`: + +.. code:: robotframework + + *** Settings *** + Test Tags all most + + *** Test Cases *** + T1 + No Operation + T2 + [Tags] one -most + No Operation + T3 + No Operation + +With tests it is possible to get the same effect by using the `Default Tags` +setting and overriding it where needed. That syntax is, however, considered +deprecated (`#4365`__) and using the new `-tag` syntax is recommended. With +keywords there was no similar functionality earlier. + +__ https://github.com/robotframework/robotframework/issues/4365 + +Dynamic and hybrid library APIs support asynchronous execution +-------------------------------------------------------------- + +Dynamic and hybrid libraries nowadays support asynchronous execution. +In practice the special methods like `get_keyword_names` and `run_keyword` +can be implemented as async methods (`#4803`_). + +Async support was added to the normal static library API in Robot Framework +6.1 (`#4089`_). A bug related to handling asynchronous keywords if execution +is stopped gracefully has also been fixed (`#4808`_). + +.. _#4089: https://github.com/robotframework/robotframework/issues/4089 + +Timestamps in result model and output.xml use standard format +------------------------------------------------------------- + +Timestamps used in the result model and stored to the output.xml file used custom +format like `20231107 19:57:01.123` earlier. Non-standard formats are seldom +a good idea, and in this case parsing the custom format turned out to be slow +as well. + +Nowadays the result model stores timestamps as standard datetime_ objects and +elapsed times as a timedelta_ (`#4258`_). This makes creating timestamps and +operating with them more convenient and considerably faster. The new objects can +be accessed via `start_time`, `end_time` and `elapsed_time` attributes that were +added as forward compatibility already in Robot Framework 6.1 (`#4765`_). +Old information is still available via the old `starttime`, `endtime` and +`elapsedtime` attributes, so this change is fully backwards compatible. + +The timestamp format in output.xml has also been changed from the custom +`YYYYMMDD HH:MM:SS.mmm` format to `ISO 8601`_ compatible +`YYYY-MM-DDTHH:MM:SS.mmmmmm`. Using a standard format makes it +easier to process output.xml files, but this change also has big positive +performance effect. Now that the result model stores timestamps as datetime_ +objects, formatting and parsing them with the available `isoformat()`__ and +`fromisoformat()`__ methods is very fast compared to custom formatting and parsing. + +A related change is that instead of storing start and end times of each executed +item in output.xml, we nowadays store their start and elapsed times. Elapsed times +are represented as floats denoting seconds. Having elapsed times directly available +is a lot more convenient than calculating them based on start and end times. +Storing start and elapsed times also takes less space than storing start and end times. + +As the result of these changes, times are available in the result model and in +output.xml in higher precision than earlier. Earlier times were stored in millisecond +granularity, but nowadays they use microseconds. Logs and reports still use milliseconds, +but that can be changed in the future if there are needs. + +Changes to output.xml are backwards incompatible and affect all external tools +that process timestamps. This is discussed more in `Changes to output.xml`_ +section below along with other output.xml changes. + +.. _datetime: https://docs.python.org/3/library/datetime.html#datetime-objects +.. _timedelta: https://docs.python.org/3/library/datetime.html#timedelta-objects +.. _#4765: https://github.com/robotframework/robotframework/issues/4765 +.. _ISO 8601: https://en.wikipedia.org/wiki/ISO_8601 +__ https://docs.python.org/3/library/datetime.html#datetime.datetime.isoformat +__ https://docs.python.org/3/library/datetime.html#datetime.datetime.fromisoformat + +Dark mode support to report and log +----------------------------------- + +Report and log got a new dark mode (`#3725`_). It is enabled automatically based +on browser and operating system preferences, but there is also a toggle to +switch between the modes. + +Backwards incompatible changes +============================== + +Python 3.6 and 3.7 are no longer supported +------------------------------------------ + +Robot Framework 7.0 requires Python 3.8 or newer (`#4294`_). The last version +that supports Python 3.6 and 3.7 is Robot Framework 6.1.1. + +Changes to output.xml +--------------------- + +The output.xml file has changed in different ways making Robot Framework 7.0 +incompatible with external tools processing output.xml files until these tools +are updated. We try to avoid this kind of breaking changes, but in this case +especially the changes to timestamps were considered so important that we +eventually would have needed to do them anyway. + +Due to the changes being relatively big, it can take some time before external +tools are updated. To allow users to take Robot Framework 7.0 into use also +if they depend on an incompatible tool, it is possible to use the new +`--legacy-output` option both as part of execution and with the Rebot tool +to generate output.xml files that are compatible with older versions. + +Timestamp related changes +~~~~~~~~~~~~~~~~~~~~~~~~~ + +The biggest changes in output.xml are related to timestamps (`#4258`_). +With earlier versions start and end times of executed items, as well as timestamps +of the logged messages, were stored using a custom `YYYYMMDD HH:MM:SS.mmm` format, +but nowadays the format is `ISO 8601`_ compatible `YYYY-MM-DDTHH:MM:SS.mmmmmm`. +In addition to that, instead of saving start and end times to `starttime` and +`endtime` attributes and message times to `timestamp`, start and elapsed times +are now stored to `start` and `elapsed` attributes and message times to `time`. + +Examples: + +.. code:: xml + + + Hello world! + + + + Hello world! + + +The new format is standard compliant, contains more detailed times, makes the elapsed +time directly available and makes the `` elements over 10% shorter. +These are all great benefits, but we are still sorry for all the extra work +this causes for those developing tools that process output.xml files. + +Keyword name related changes +~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +How keyword names are stored in output.xml has changed slightly (`#4884`_). +With each executed keywords we store both the name of the keyword and the name +of the library or resource file containing it. Earlier the latter was stored to +attribute `library` also with resource files, but nowadays the attribute is generic +`owner`. In addition to `owner` being a better name in general, it also +matches the new `owner` attribute keywords in the result model have. + +Another change is that the original name stored with keywords using embedded +arguments is nowadays in `source_name` attribute when it used to be in `sourcename`. +This change was done to make the attribute consistent with the attribute in +the result model. + +Examples: + +.. code:: xml + + + ... + ... + + + ... + ... + +Other changes +~~~~~~~~~~~~~ + +Nowadays keywords and control structures can have a message. Messages are represented +as the text of the `` element, and they have been present already earlier with +tests and suites. Related to this, control structured cannot anymore have ``. +(`#4883`_) + +These changes should not cause problems for tools processing output.xml files, +but storing messages with each failed keyword and control structure may +increase the output.xml size. + +Schema updates +~~~~~~~~~~~~~~ + +The output.xml schema has been updated and can be found via +https://github.com/robotframework/robotframework/tree/master/doc/schema/. + +Changes to result model +----------------------- + +There have been some changes to the result model that unfortunately affect +external tools using it. The main motivation for these changes has been +cleaning up the model before creating a JSON representation for it (`#4847`_). + +Changes related to keyword names +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The biggest changes are related to keyword names (`#4884`_). Earlier `Keyword` +objects had a `name` attribute that contained the full keyword name like +`BuiltIn.Log`. The actual keyword name and the name of the library or resource +file that the keyword belonged to were in `kwname` and `libname` attributes, +respectively. In addition to these, keywords using embedded arguments also had +a `sourcename` attribute containing the original keyword name. + +Due to reasons explained in `#4884`_, the following changes have been made +in Robot Framework 7.0: + +- Old `kwname` is renamed to `name`. This is consistent with the execution side `Keyword`. +- Old `libname` is renamed to generic `owner`. +- New `full_name` is introduced to replace the old `name`. +- `sourcename` is renamed to `source_name`. +- `kwname`, `libname` and `sourcename` are preserved as properties. They are considered + deprecated, but accessing them does not cause a deprecation warning yet. + +The backwards incompatible part of this change is changing the meaning of the +`name` attribute. It used to be a read-only property yielding the full name +like `BuiltIn.Log`, but now it is a normal attribute that contains just the actual +keyword name like `Log`. All other old attributes have been preserved as properties +and code using them does not need to be updated immediately. + +Deprecated attributes have been removed +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +The following attributes that were deprecated already in Robot Framework 4.0 +have been removed (`#4846`_): + +- `TestSuite.keywords`. Use `TestSuite.setup` and `TestSuite.teardown` instead. +- `TestCase.keywords`. Use `TestCase.body`, `TestCase.setup` and `TestCase.teardown` instead. +- `Keyword.keywords`. Use `Keyword.body` and `Keyword.teardown` instead. +- `Keyword.children`. Use `Keyword.body` and `Keyword.teardown` instead. +- `TestCase.critical`. The whole criticality concept has been removed. + +Additionally, `TestSuite.keywords` and `TestCase.keywords` have been removed +from the execution model. + +Changes to parsing model +------------------------ + +There have been some changes also to the parsing model: + +- The node representing the deprecated `[Return]` setting has been renamed from + `Return` to `ReturnSetting`. At the same time, the node representing the + `RETURN` statement has been renamed from `ReturnStatement` to `Return` (`#4939`_). + + To ease transition, `ReturnSetting` has existed as an alias for `Return` starting + from Robot Framework 6.1 (`#4656`_) and `ReturnStatement` is preserved as an alias + now. In addition to that, the `ModelVisitor` base class has special handling for + `visit_ReturnSetting` and `visit_ReturnStatement` visitor methods so that they work + correctly with `ReturnSetting` and `ReturnStatement` with Robot Framework 6.1 and + newer. Issue `#4939`_ explains this in more detail and has a concrete example + how to support also older Robot Framework versions. + +- The node representing the `Test Tags` setting as well as the deprecated + `Force Tags` setting has been renamed from `ForceTags` to `TestTags` (`#4385`_). + `ModelVisitor` has special handling for the `visit_ForceTags` method so + that it will continue to work also after the change. + +- The token type used with `AS` (or `WITH NAME`) in library imports has been changed + to `Token.AS` (`#4375`_). `Token.WITH_NAME` still exists as an alias for `Token.AS`. + +- Statement `type` and `tokens` have been moved from `_fields` to `_attributes` (`#4912`_). + This may affect debugging the model. + +.. _#4656: https://github.com/robotframework/robotframework/issues/4656 + +Changes to Libdoc spec files +---------------------------- + +The following deprecated constructs have been removed from Libdoc spec files (`#4667`_): + +- `datatypes` have been removed from XML or JSON spec files. They were deprecated in + favor of `typedocs` already in Robot Framework 5.0 (`#4160`_). +- Type names are not anymore written to XML specs as content of the `` elements. + The name is available as the `name` attribute of `` elements since + Robot Framework 6.1 (`#4538`_). +- `types` and `typedocs` attributes have been removed from arguments in JSON specs. + The `type` attribute introduced in RF 6.1 (`#4538`_) needs to be used instead. + +Libdoc schema files have been updated and can be found via +https://github.com/robotframework/robotframework/tree/master/doc/schema/. + +.. _#4160: https://github.com/robotframework/robotframework/issues/4160 +.. _#4538: https://github.com/robotframework/robotframework/issues/4538 + +Changes to selecting tests with `--suite`, `--test` and `--include` +------------------------------------------------------------------- + +There are two changes related to selecting tests: + +- When using `--test` and `--include` together, tests matching either of them + are selected (`#4721`_). Earlier tests need to match both options to be selected. + +- When selecting a suite using its parent suite as a prefix like `--suite parent.suite`, + the given name must match the full suite name (`#4720`_). Earlier it was enough if + the prefix matched the closest parent or parents. + +Other backwards incompatible changes +------------------------------------ + +- The default value of the `stdin` argument used with `Process` library keyword + has been changed from `subprocess.PIPE` to `None` (`#4103`_). This change ought + to avoid processes hanging in some cases. Those who depend on the old behavior + need to use `stdin=PIPE` explicitly to enable that. + +- When type hints are specified as strings, they must use format `type`, `type[param]`, + `type[p1, p2]` or `t1 | t2` (`#4711`_). Using other formats will cause errors taking + keywords into use. In practice problems occur if the special characters `[`, `]`, `,` + and `|` occur in unexpected places. For example, `arg: "Hello, world!"` will cause + an error due to the comma. + +- `datetime`, `date` and `timedelta` objects are sent over the Remote interface + differently than earlier (`#4784`_). They all used to be converted to strings, but + nowadays `datetime` is sent as-is, `date` is converted to `datetime` and sent like + that, and `timedelta` is converted to a `float` by using `timedelta.total_seconds()`. + +- Argument conversion support with `collections.abc.ByteString` has been removed (`#4983`_). + The reason is that `ByteString` is deprecated and will be removed in Python 3.14. + It has not been too often needed, but if you happen to use it, you can change + `arg: ByteString` to `arg: bytes | bytearray` and the functionality + stays exactly the same. + +- Paths passed to result file related listener version 3 methods like `output_file` + and `log_file` have been changed from strings to `pathlib.Path` objects (`#4988`_). + Most of the time both kinds of paths work interchangeably, so this change is unlikely + to cause issues. If you need to handle these paths as strings, they can be converted + by using `str(path)`. + +- `robot.utils.normalize` does not anymore support bytes (`#4936`_). + +- Deprecated `accept_plain_values` argument has been removed from the + `timestr_to_secs` utility function (`#4861`_). + +Deprecations +============ + +`[Return]` setting +------------------ + +The `[Return]` setting for specifying the return value from user keywords has +been "loudly" deprecated (`#4876`_). It has been "silently" deprecated since +Robot Framework 5.0 when the much more versatile `RETURN` setting was introduced +(`#4078`_), but now using it will cause a deprecation warning. The plan is to +preserve the `[Return]` setting at least until Robot Framework 8.0. + +If you have lot of data that uses `[Return]`, the easiest way to update it is +using the Robotidy_ tool that can convert `[Return]` to `RETURN` automatically. +If you have data that is executed also with Robot Framework versions that do +not support `RETURN`, you can use the `Return From Keyword` keyword instead. +That keyword will eventually be deprecated and removed as well, though. + +.. _#4078: https://github.com/robotframework/robotframework/issues/4078 +.. _Robotidy: https://robotidy.readthedocs.io + +Singular section headers +------------------------ + +Using singular section headers like `*** Test Case ***` or `*** Setting ***` +nowadays causes a deprecation warning (`#4432`_). They were silently deprecated +in Robot Framework 6.0 for reasons explained in issue `#4431`_. + +.. _#4431: https://github.com/robotframework/robotframework/issues/4431 + +Deprecated attributes in parsing, running and result models +----------------------------------------------------------- + +- In the parsing model, `For.variables`, `ForHeader.variables`, `Try.variable` and + `ExceptHeader.variable` attributes have been deprecated in favor of the new `assign` + attribute (`#4708`_). + +- In running and result models, `For.variables` and `TryBranch.variable` have been + deprecated in favor of the new `assign` attribute (`#4708`_). + +- In the result model, control structures like `FOR` were earlier modeled so that they + looked like keywords. Nowadays they are considered totally different objects and + their keyword specific attributes `name`, `kwnane`, `libname`, `doc`, `args`, + `assign`, `tags` and `timeout` have been deprecated (`#4846`_). + +- `starttime`, `endtime` and `elapsed` time attributes in the result model have been + silently deprecated (`#4258`_). Accessing them does not yet cause a deprecation + warning, but users are recommended to use `start_time`, `end_time` and + `elapsed_time` attributes that are available since Robot Framework 6.1. + +- `kwname`, `libname` and `sourcename` attributes used by the `Keyword` object + in the result model have been silently deprecated (`#4884`_). New code should use + `name`, `owner` and `source_name` instead. + +Other deprecated features +------------------------- + +- Using embedded arguments with a variable that has a value not matching custom + embedded argument patterns nowadays causes a deprecation warning (`#4524`_). + Earlier variables used as embedded arguments were always accepted without + validating values. + +- Using `FOR IN ZIP` loops with lists having different lengths without explicitly + using `mode=SHORTEST` has been deprecated (`#4685`_). The strict mode where lengths + must match will be the default mode in the future. + +- Various utility functions in the `robot.utils` package that are no longer used + by Robot Framework itself, including the whole Python 2/3 compatibility layer, + have been deprecated (`#4501`_). If you need some of these utils, you can copy + their code to your own tool or library. This change may affect existing + libraries and tools in the ecosystem. + +- `case_insensitive` and `whitespace_insensitive` arguments used by some + Collections and String library keywords have been deprecated in favor of + `ignore_case` and `ignore_whitespace`. The new arguments were added for + consistency reasons (`#4954`_) and the old arguments will continue to work + for the time being. + +- Passing time as milliseconds to the `elapsed_time_to_string` utility function + has been deprecated (`#4862`_). + +Acknowledgements +================ + +Robot Framework development is sponsored by the `Robot Framework Foundation`_ +and its over 60 member organizations. If your organization is using Robot Framework +and benefiting from it, consider joining the foundation to support its +development as well. + +Robot Framework 7.0 team funded by the foundation consists of `Pekka Klärck`_ and +`Janne Härkönen `_ (part time). +In addition to work done by them, the community has provided some great contributions: + +- `Ygor Pontelo `__ added async support to the + dynamic and hybrid library APIs (`#4803`_) and fixed a bug with handling async + keywords when execution is stopped gracefully (`#4808`_). + +- `Topi 'top1' Tuulensuu `__ fixed a performance regression + when using `Run Keyword` so that the name of the executed keyword contains a variable + (`#4659`_). + +- `Pasi Saikkonen `__ added dark mode to reports + and logs (`#3725`_). + +- `René `__ added return type information to Libdoc's + HTML output (`#3017`_), fixed `DotDict` equality comparisons (`#4956`_) and + helped finalizing the dark mode support (`#3725`_). + +- `Robin `__ added type hints to modules that + did not yet have them under the public `robot.api` package (`#4841`_). + +- `Mark Moberts `__ added case-insensitive list and + dictionary comparison support to the Collections library (`#4343`_). + +- `Daniel Biehl `__ enhanced performance of traversing + the parsing model using `ModelVisitor` (`#4934`_). + +Big thanks to Robot Framework Foundation, to community members listed above, and to +everyone else who has tested preview releases, submitted bug reports, proposed +enhancements, debugged problems, or otherwise helped with Robot Framework 7.0 +development. + +See you at `RoboCon 2024 `__ either onsite or online! + +| `Pekka Klärck`_ +| Robot Framework lead developer + +Full list of fixes and enhancements +=================================== + +.. list-table:: + :header-rows: 1 + + * - ID + - Type + - Priority + - Summary + * - `#3296`_ + - enhancement + - critical + - Support keywords and control structures with listener version 3 + * - `#3761`_ + - enhancement + - critical + - Native `VAR` syntax to create variables inside tests and keywords + * - `#4294`_ + - enhancement + - critical + - Drop Python 3.6 and 3.7 support + * - `#4710`_ + - enhancement + - critical + - Support library keywords with both embedded and normal arguments + * - `#4847`_ + - enhancement + - critical + - Support JSON serialization with result model + * - `#4659`_ + - bug + - high + - Performance regression when using `Run Keyword` and keyword name contains a variable + * - `#4921`_ + - bug + - high + - Log levels don't work correctly with `robot:flatten` + * - `#3725`_ + - enhancement + - high + - Support dark theme with report and log + * - `#4258`_ + - enhancement + - high + - Change timestamps from custom strings to `datetime` in result model and to ISO 8601 format in output.xml + * - `#4374`_ + - enhancement + - high + - Support removing tags set globally by using `-tag` syntax with `[Tags]` setting + * - `#4633`_ + - enhancement + - high + - Automatic argument conversion and validation for `Literal` + * - `#4711`_ + - enhancement + - high + - Support type aliases in formats `'list[int]'` and `'int | float'` in argument conversion + * - `#4803`_ + - enhancement + - high + - Async support to dynamic and hybrid library APIs + * - `#4808`_ + - bug + - medium + - Async keywords are not stopped when execution is stopped gracefully + * - `#4859`_ + - bug + - medium + - Parsing errors in reStructuredText files have no source + * - `#4880`_ + - bug + - medium + - Initially empty test fails even if pre-run modifier adds content to it + * - `#4886`_ + - bug + - medium + - `Set Variable If` is slow if it has several conditions + * - `#4898`_ + - bug + - medium + - Resolving special variables can fail with confusing message + * - `#4915`_ + - bug + - medium + - `cached_property` attributes are called when importing library + * - `#4924`_ + - bug + - medium + - WHILE `on_limit` missing from listener v2 attributes + * - `#4926`_ + - bug + - medium + - WHILE and TRY content are not removed with `--removekeywords all` + * - `#4945`_ + - bug + - medium + - `TypedDict` with forward references do not work in argument conversion + * - `#4956`_ + - bug + - medium + - DotDict behaves inconsistent on equality checks. `x == y` != `not x != y` and not `x != y` == `not x == y` + * - `#4964`_ + - bug + - medium + - Variables set using `Set Suite Variable` with `children=True` cannot be properly overwritten + * - `#4980`_ + - bug + - medium + - DateTime library uses deprecated `datetime.utcnow()` + * - `#4999`_ + - bug + - medium + - XML Library: Double namespace during Element To String + * - `#5005`_ + - bug + - medium + - `Log Variables` should not consume iterables + * - `#3017`_ + - enhancement + - medium + - Add return type to Libdoc specs and HTML output + * - `#4103`_ + - enhancement + - medium + - Process: Change the default `stdin` behavior from `subprocess.PIPE` to `None` + * - `#4302`_ + - enhancement + - medium + - Remove `Reserved` library + * - `#4343`_ + - enhancement + - medium + - Collections: Support case-insensitive list and dictionary comparisons + * - `#4375`_ + - enhancement + - medium + - Change token type of `AS` (or `WITH NAME`) used with library imports to `Token.AS` + * - `#4385`_ + - enhancement + - medium + - Change the parsing model object produced by `Test Tags` (and `Force Tags`) to `TestTags` + * - `#4432`_ + - enhancement + - medium + - Loudly deprecate singular section headers + * - `#4501`_ + - enhancement + - medium + - Loudly deprecate old Python 2/3 compatibility layer and other deprecated utils + * - `#4524`_ + - enhancement + - medium + - Loudly deprecate variables used as embedded arguments not matching custom patterns + * - `#4545`_ + - enhancement + - medium + - Support creating assigned variable name based on another variable like `${${var}} = Keyword` + * - `#4667`_ + - enhancement + - medium + - Remove deprecated constructs from Libdoc spec files + * - `#4685`_ + - enhancement + - medium + - Deprecate `SHORTEST` mode being default with `FOR IN ZIP` loops + * - `#4708`_ + - enhancement + - medium + - Use `assing`, not `variable`, with FOR and TRY/EXCEPT model objects when referring to assigned variables + * - `#4720`_ + - enhancement + - medium + - Require `--suite parent.suite` to match the full suite name + * - `#4721`_ + - enhancement + - medium + - Change behavior of `--test` and `--include` so that they are cumulative + * - `#4747`_ + - enhancement + - medium + - Support `[Setup]` with user keywords + * - `#4784`_ + - enhancement + - medium + - Remote: Enhance `datetime`, `date` and `timedelta` conversion + * - `#4841`_ + - enhancement + - medium + - Add typing to all modules under `robot.api` + * - `#4846`_ + - enhancement + - medium + - Result model: Loudly deprecate not needed attributes and remove already deprecated ones + * - `#4872`_ + - enhancement + - medium + - Control continue-on-failure mode by using recursive and non-recursive tags together + * - `#4876`_ + - enhancement + - medium + - Loudly deprecate `[Return]` setting + * - `#4877`_ + - enhancement + - medium + - XML: Support ignoring element order with `Elements Should Be Equal` + * - `#4883`_ + - enhancement + - medium + - Result model: Add `message` to keywords and control structures and remove `doc` from controls + * - `#4884`_ + - enhancement + - medium + - Result model: Enhance storing keyword name + * - `#4896`_ + - enhancement + - medium + - Support `separator=` configuration option with scalar variables in Variables section + * - `#4903`_ + - enhancement + - medium + - Support argument conversion and named arguments with dynamic variable files + * - `#4905`_ + - enhancement + - medium + - Support creating variable name based on another variable like `${${VAR}}` in Variables section + * - `#4910`_ + - enhancement + - medium + - Make listener v3 the default listener API + * - `#4912`_ + - enhancement + - medium + - Parsing model: Move `type` and `tokens` from `_fields` to `_attributes` + * - `#4930`_ + - enhancement + - medium + - BuiltIn: New `Reset Log Level` keyword for resetting the log level to the original value + * - `#4939`_ + - enhancement + - medium + - Parsing model: Rename `Return` to `ReturnSetting` and `ReturnStatement` to `Return` + * - `#4942`_ + - enhancement + - medium + - Add public argument conversion API for libraries and other tools + * - `#4952`_ + - enhancement + - medium + - Collections: Make `ignore_order` and `ignore_keys` recursive + * - `#4960`_ + - enhancement + - medium + - Support integer conversion with strings representing whole number floats like `'1.0'` and `'2e10'` + * - `#4976`_ + - enhancement + - medium + - Support string `SELF` (case-insenstive) when library registers itself as listener + * - `#4979`_ + - enhancement + - medium + - Add `robot.result.TestSuite.to/from_xml` methods + * - `#4982`_ + - enhancement + - medium + - DateTime: Support `datetime.date` as an input format with date related keywords + * - `#4983`_ + - enhancement + - medium + - Type conversion: Remove support for deprecated `ByteString` + * - `#5000`_ + - enhancement + - medium + - Nicer API for setting keyword call arguments programmatically + * - `#4934`_ + - --- + - medium + - Enhance performance of visiting parsing model + * - `#4621`_ + - bug + - low + - OperatingSystem library docs have broken link / title + * - `#4798`_ + - bug + - low + - `--removekeywords passed` doesn't remove test setup and teardown + * - `#4867`_ + - bug + - low + - Original order of dictionaries is not preserved when they are pretty printed in log messages + * - `#4870`_ + - bug + - low + - User keyword teardown missing from running model JSON schema + * - `#4904`_ + - bug + - low + - Importing static variable file with arguments does not fail + * - `#4913`_ + - bug + - low + - Trace log level logs arguments twice for embedded arguments + * - `#4927`_ + - bug + - low + - WARN level missing from the log level selector in log.html + * - `#4967`_ + - bug + - low + - Variables are not resolved in keyword name in WUKS error message + * - `#4861`_ + - enhancement + - low + - Remove deprecated `accept_plain_values` from `timestr_to_secs` utility function + * - `#4862`_ + - enhancement + - low + - Deprecate `elapsed_time_to_string` accepting time as milliseconds + * - `#4864`_ + - enhancement + - low + - Process: Make warning about processes hanging if output buffers get full more visible + * - `#4885`_ + - enhancement + - low + - Add `full_name` to replace `longname` to suite and test objects + * - `#4900`_ + - enhancement + - low + - Make keywords and control structures in log look more like original data + * - `#4922`_ + - enhancement + - low + - Change the log level of `Set Log Level` message from INFO to DEBUG + * - `#4933`_ + - enhancement + - low + - Type conversion: Ignore hyphens when matching enum members + * - `#4935`_ + - enhancement + - low + - Use `casefold`, not `lower`, when comparing strings case-insensitively + * - `#4936`_ + - enhancement + - low + - Remove bytes support from `robot.utils.normalize` function + * - `#4954`_ + - enhancement + - low + - Collections and String: Add `ignore_case` as alias for `case_insensitive` + * - `#4958`_ + - enhancement + - low + - Document `robot_running` and `dry_run_active` properties of the BuiltIn library in the User Guide + * - `#4975`_ + - enhancement + - low + - Support `times` and `x` suffixes with `WHILE` limit to make it more compatible with `Wait Until Keyword Succeeds` + * - `#4988`_ + - enhancement + - low + - Change paths passed to listener v3 methods to `pathlib.Path` instances + +Altogether 88 issues. View on the `issue tracker `__. + +.. _#3296: https://github.com/robotframework/robotframework/issues/3296 +.. _#3761: https://github.com/robotframework/robotframework/issues/3761 +.. _#4294: https://github.com/robotframework/robotframework/issues/4294 +.. _#4710: https://github.com/robotframework/robotframework/issues/4710 +.. _#4847: https://github.com/robotframework/robotframework/issues/4847 +.. _#4659: https://github.com/robotframework/robotframework/issues/4659 +.. _#4921: https://github.com/robotframework/robotframework/issues/4921 +.. _#3725: https://github.com/robotframework/robotframework/issues/3725 +.. _#4258: https://github.com/robotframework/robotframework/issues/4258 +.. _#4374: https://github.com/robotframework/robotframework/issues/4374 +.. _#4633: https://github.com/robotframework/robotframework/issues/4633 +.. _#4711: https://github.com/robotframework/robotframework/issues/4711 +.. _#4803: https://github.com/robotframework/robotframework/issues/4803 +.. _#4808: https://github.com/robotframework/robotframework/issues/4808 +.. _#4859: https://github.com/robotframework/robotframework/issues/4859 +.. _#4880: https://github.com/robotframework/robotframework/issues/4880 +.. _#4886: https://github.com/robotframework/robotframework/issues/4886 +.. _#4898: https://github.com/robotframework/robotframework/issues/4898 +.. _#4915: https://github.com/robotframework/robotframework/issues/4915 +.. _#4924: https://github.com/robotframework/robotframework/issues/4924 +.. _#4926: https://github.com/robotframework/robotframework/issues/4926 +.. _#4945: https://github.com/robotframework/robotframework/issues/4945 +.. _#4956: https://github.com/robotframework/robotframework/issues/4956 +.. _#4964: https://github.com/robotframework/robotframework/issues/4964 +.. _#4980: https://github.com/robotframework/robotframework/issues/4980 +.. _#4999: https://github.com/robotframework/robotframework/issues/4999 +.. _#5005: https://github.com/robotframework/robotframework/issues/5005 +.. _#3017: https://github.com/robotframework/robotframework/issues/3017 +.. _#4103: https://github.com/robotframework/robotframework/issues/4103 +.. _#4302: https://github.com/robotframework/robotframework/issues/4302 +.. _#4343: https://github.com/robotframework/robotframework/issues/4343 +.. _#4375: https://github.com/robotframework/robotframework/issues/4375 +.. _#4385: https://github.com/robotframework/robotframework/issues/4385 +.. _#4432: https://github.com/robotframework/robotframework/issues/4432 +.. _#4501: https://github.com/robotframework/robotframework/issues/4501 +.. _#4524: https://github.com/robotframework/robotframework/issues/4524 +.. _#4545: https://github.com/robotframework/robotframework/issues/4545 +.. _#4667: https://github.com/robotframework/robotframework/issues/4667 +.. _#4685: https://github.com/robotframework/robotframework/issues/4685 +.. _#4708: https://github.com/robotframework/robotframework/issues/4708 +.. _#4720: https://github.com/robotframework/robotframework/issues/4720 +.. _#4721: https://github.com/robotframework/robotframework/issues/4721 +.. _#4747: https://github.com/robotframework/robotframework/issues/4747 +.. _#4784: https://github.com/robotframework/robotframework/issues/4784 +.. _#4841: https://github.com/robotframework/robotframework/issues/4841 +.. _#4846: https://github.com/robotframework/robotframework/issues/4846 +.. _#4872: https://github.com/robotframework/robotframework/issues/4872 +.. _#4876: https://github.com/robotframework/robotframework/issues/4876 +.. _#4877: https://github.com/robotframework/robotframework/issues/4877 +.. _#4883: https://github.com/robotframework/robotframework/issues/4883 +.. _#4884: https://github.com/robotframework/robotframework/issues/4884 +.. _#4896: https://github.com/robotframework/robotframework/issues/4896 +.. _#4903: https://github.com/robotframework/robotframework/issues/4903 +.. _#4905: https://github.com/robotframework/robotframework/issues/4905 +.. _#4910: https://github.com/robotframework/robotframework/issues/4910 +.. _#4912: https://github.com/robotframework/robotframework/issues/4912 +.. _#4930: https://github.com/robotframework/robotframework/issues/4930 +.. _#4939: https://github.com/robotframework/robotframework/issues/4939 +.. _#4942: https://github.com/robotframework/robotframework/issues/4942 +.. _#4952: https://github.com/robotframework/robotframework/issues/4952 +.. _#4960: https://github.com/robotframework/robotframework/issues/4960 +.. _#4976: https://github.com/robotframework/robotframework/issues/4976 +.. _#4979: https://github.com/robotframework/robotframework/issues/4979 +.. _#4982: https://github.com/robotframework/robotframework/issues/4982 +.. _#4983: https://github.com/robotframework/robotframework/issues/4983 +.. _#5000: https://github.com/robotframework/robotframework/issues/5000 +.. _#4934: https://github.com/robotframework/robotframework/issues/4934 +.. _#4621: https://github.com/robotframework/robotframework/issues/4621 +.. _#4798: https://github.com/robotframework/robotframework/issues/4798 +.. _#4867: https://github.com/robotframework/robotframework/issues/4867 +.. _#4870: https://github.com/robotframework/robotframework/issues/4870 +.. _#4904: https://github.com/robotframework/robotframework/issues/4904 +.. _#4913: https://github.com/robotframework/robotframework/issues/4913 +.. _#4927: https://github.com/robotframework/robotframework/issues/4927 +.. _#4967: https://github.com/robotframework/robotframework/issues/4967 +.. _#4861: https://github.com/robotframework/robotframework/issues/4861 +.. _#4862: https://github.com/robotframework/robotframework/issues/4862 +.. _#4864: https://github.com/robotframework/robotframework/issues/4864 +.. _#4885: https://github.com/robotframework/robotframework/issues/4885 +.. _#4900: https://github.com/robotframework/robotframework/issues/4900 +.. _#4922: https://github.com/robotframework/robotframework/issues/4922 +.. _#4933: https://github.com/robotframework/robotframework/issues/4933 +.. _#4935: https://github.com/robotframework/robotframework/issues/4935 +.. _#4936: https://github.com/robotframework/robotframework/issues/4936 +.. _#4954: https://github.com/robotframework/robotframework/issues/4954 +.. _#4958: https://github.com/robotframework/robotframework/issues/4958 +.. _#4975: https://github.com/robotframework/robotframework/issues/4975 +.. _#4988: https://github.com/robotframework/robotframework/issues/4988 diff --git a/test/markups/README.long.rst.html b/test/markups/README.long.rst.html new file mode 100644 index 00000000..7f9e1ac3 --- /dev/null +++ b/test/markups/README.long.rst.html @@ -0,0 +1,1303 @@ +

      Robot Framework 7.0

      +

      Robot Framework 7.0 is a new major release with highly enhanced listener interface +(#3296), native VAR syntax for creating variables (#3761), support for +mixing embedded and normal arguments with library keywords (#4710), JSON +result format (#4847) and various other enhancements and bug fixes.

      +

      Robot Framework 7.0 was released on Thursday January 11, 2024. Questions and comments +related to the release can be sent to the #devel channel on Robot Framework Slack +and possible bugs submitted to the issue tracker.

      +
      + +
      + +

      Installation

      +

      If you have pip installed, just run

      +
      +pip install --upgrade robotframework
      +
      +

      to install the latest available stable release or use

      +
      +pip install robotframework==7.0
      +
      +

      to install exactly this version. Alternatively you can download the package +from PyPI and install it manually. For more details and other installation +approaches, see the installation instructions.

      + +

      Most important enhancements

      +
      +

      If you are interested to learn more about the new features in Robot Framework 7.0, +join the RoboCon conference in February, 2024. Pekka Klärck, Robot Framework +lead developer, will go through the key features briefly in the onsite conference +in Helsinki and more thoroughly in the online edition.

      +

      The conference has also dozens of other great talks, workshops and a lot of +possibilities to meet other community members as well as developers of various +tools and libraries in the ecosystem. All profits from the conference will be +used for future Robot Framework development.

      +
      + +

      Listener enhancements

      +

      Robot Framework's listener interface is a very powerful mechanism to get +notifications about various events during execution and it also allows modifying +data and results on the fly. It is not typically directly used by normal Robot +Framework users, but they are likely to use tools that use it internally. +The listener API has been significantly enhanced making it possible +to create even more powerful and interesting tools in the future.

      + +

      Support keywords and control structures with listener version 3

      +

      The major limitation with the listener API has been that the listener +API version 2 only supports getting notifications, not making modifications, +and that the more powerful listener API version 3 has only supported suites +and tests/tasks.

      +

      The biggest enhancement in the whole Robot Framework 7.0 is that the listener +version 3 has been extended to support also keywords and control structures (#3296). +For example, a listener having the following methods prints information +about started keywords and ended WHILE loops:

      +
      +from robot import result, running
      +
      +
      +def start_keyword(data: running.Keyword, result: result.Keyword):
      +    print(f"Keyword '{result.full_name}' used on line {data.lineno} started.")
      +
      +
      +def end_while(data: running.While, result: result.While):
      +    print(f"WHILE loop on line {data.lineno} ended with status {result.status} "
      +          f"after {len(result.body)} iterations.")
      +
      +

      With keyword calls it is possible to also get more information about the actually +executed keyword. For example, the following listener prints some information +about the executed keyword and the library it belongs to:

      +
      +from robot.running import Keyword as KeywordData, LibraryKeyword
      +from robot.result import Keyword as KeywordResult
      +
      +
      +def start_library_keyword(data: KeywordData,
      +                          implementation: LibraryKeyword,
      +                          result: KeywordResult):
      +    library = implementation.owner
      +    print(f"Keyword '{implementation.name}' is implemented in library "
      +          f"'{library.name}' at '{implementation.source}' on line "
      +          f"{implementation.lineno}. The library has {library.scope.name} "
      +          f"scope and the current instance is {library.instance}.")
      +
      +

      As the above example already illustrated, it is even possible to get an access to +the actual library instance. This means that listeners can inspect the library +state and also modify it. With user keywords it is even possible to modify +the keyword itself or, via the owner resource file, any other keyword in +the resource file.

      +

      Listeners can also modify results if needed. Possible use cases include hiding +sensitive information and adding more details to results based on external sources.

      +

      Notice that although listener can change status of any executed keyword or control +structure, that does not directly affect the status of the executed test. In general +listeners cannot directly fail keywords so that execution would stop or handle +failures so that execution would continue. This kind of functionality may be +added in the future if there are needs.

      +

      The new listener version 3 methods are so powerful and versatile that going them +through thoroughly in these release notes is not possible. For more examples, you +can see the acceptance tests using the methods in various interesting and even +crazy ways.

      + +

      Listener version 3 is the default listener version

      +

      Earlier listeners always needed to specify the API version they used with the +ROBOT_LISTENER_API_VERSION attribute. Now that the listener version 3 got +the new methods, it is considered so much more powerful than the version 2 +that it was made the default listener version (#4910).

      +

      The listener version 2 continues to work, but using it requires specifying +the listener version as earlier. The are no plans to deprecate the listener +version 2, but we nevertheless highly recommend using the version 3 whenever +possible.

      + +

      Libraries can register themselves as listeners by using string SELF +

      +

      Listeners are typically enabled from the command line, but libraries +can register listeners as well. Often libraries themselves want to act +as listeners, and that has earlier required using self.ROBOT_LIBRARY_LISTENER = self +in the __init__ method. Robot Framework 7.0 makes it possible to use string +SELF (case-insensitive) for this purpose as well (#4910), which means +that a listener can be specified as a class attribute and not only in __init__. +This is especially convenient when using the @library decorator:

      +
      +from robot.api.deco import keyword, library
      +
      +
      +@library(listener='SELF')
      +class Example:
      +
      +    def start_suite(self, data, result):
      +        ...
      +
      +    @keyword
      +    def example(self, arg):
      +        ...
      +
      + +

      Nicer API for modifying keyword arguments

      +

      Modifying keyword call arguments programmatically has been made more convenient +(#5000). This enhancement eases modifying arguments using the new listener +version 3 start/end_keyword methods.

      + +

      Paths are passed to version 3 listeners as pathlib.Path objects

      +

      Listeners have methods like output_file and log_file that are called when +result files are ready so that they get the file path as an argument. Earlier +paths were strings, but nowadays listener version 3 methods get them as +more convenient pathlib.Path objects.

      + +

      Native VAR syntax

      +

      The new VAR syntax (#3761) makes it possible to create local variables +as well as global, suite and test/task scoped variables dynamically during +execution. The motivation is to have a more convenient syntax than using +the Set Variable keyword for creating local variables and to unify +the syntax for creating variables in different scopes. Except for the mandatory +VAR marker, the syntax is also the same as when creating variables in the +Variables section. The syntax is best explained with examples:

      +
      +*** Test Cases ***
      +Example
      +    # Create a local variable `${local}` with a value `value`.
      +    VAR    ${local}    value
      +
      +    # Create a variable that is available throughout the whole suite.
      +    # Supported scopes are GLOBAL, SUITE, TEST, TASK and LOCAL (default).
      +    VAR    ${suite}    value    scope=SUITE
      +
      +    # Validate created variables.
      +    Should Be Equal    ${local}    value
      +    Should Be Equal    ${suite}    value
      +
      +Example continued
      +    # Suite level variables are seen also by subsequent tests.
      +    Should Be Equal    ${suite}    value
      +
      +

      When creating ${scalar} variables having long values, it is possible to split +the value to multiple lines. Lines are joined together with a space by default, +but that can be changed with the separator configuration option. Similarly as +in the Variables section, it is possible to create also @{list} and &{dict} +variables. Unlike in the Variables section, variables can be created conditionally +using IF/ELSE structures:

      +
      +*** Test Cases ***
      +Long value
      +    VAR    ${long}
      +    ...    This value is rather long.
      +    ...    It has been split to multiple lines.
      +    ...    Parts will be joined together with a space.
      +
      +Multiline
      +    VAR    ${multiline}
      +    ...    First line.
      +    ...    Second line.
      +    ...    Last line.
      +    ...    separator=\n
      +
      +List
      +    # Creates a list with three items.
      +    VAR    @{list}    a    b    c
      +
      +Dictionary
      +    # Creates a dictionary with two items.
      +    VAR    &{dict}    key=value    second=item
      +
      +Normal IF
      +    IF    1 > 0
      +        VAR    ${x}    true value
      +    ELSE
      +        VAR    ${x}    false value
      +    END
      +
      +Inline IF
      +    IF    1 > 0    VAR    ${x}    true value    ELSE    VAR    ${x}    false value
      +
      + +

      Mixed argument support with library keywords

      +

      User keywords got support to use both embedded and normal arguments in Robot +Framework 6.1 (#4234) and now that support has been added also to library keywords +(#4710). The syntax works so, that if a function or method implementing a keyword +accepts more arguments than there are embedded arguments, the remaining arguments +can be passed in as normal arguments. This is illustrated by the following example +keyword:

      +
      +@keyword('Number of ${animals} should be')
      +def example(animals, count):
      +    ...
      +
      +

      The above keyword could be used like this:

      +
      +*** Test Cases ***
      +Example
      +    Number of horses should be    2
      +    Number of horses should be    count=2
      +    Number of dogs should be    3
      +
      + +

      JSON result format

      +

      Robot Framework 6.1 added support to convert test/task data to JSON and back +and Robot Framework 7.0 extends the JSON serialization support to execution results +(#4847). One of the core use cases for data serialization was making it easy to +transfer data between process and machines, and now it is also easy to pass results +back.

      +

      Also the built-in Rebot tool that is used for post-processing results supports +JSON files both in output and in input. Creating JSON output files is done using +the normal --output option so that the specified file has a .json extension:

      +
      +rebot --output output.json output.xml
      +
      +

      When reading output files, JSON files are automatically recognized by +the extension:

      +
      +rebot output.json
      +rebot output1.json output2.json
      +
      +

      When combining or merging results, it is possible to mix JSON and XML files:

      +
      +rebot output1.xml output2.json
      +rebot --merge original.xml rerun.json
      +
      +

      The JSON output file structure is documented in the result.json schema file.

      +

      The plan is to enhance the support for JSON output files in the future so that +they could be created already during execution. For more details see issue #3423.

      + +

      Argument conversion enhancements

      +

      Automatic argument conversion is a very powerful feature that library developers +can use to avoid converting arguments manually and to get more useful Libdoc +documentation. There are two important new enhancements to it.

      + +

      Support for Literal +

      +

      In Python, the Literal type makes it possible to type arguments so that type +checkers accept only certain values. For example, this function only accepts +strings x, y and z:

      +
      +def example(arg: Literal['x', 'y', 'z']):
      +    ...
      +
      +

      Robot Framework has been enhanced so that it validates that an argument having +a Literal type can only be used with the specified values (#4633). For +example, using a keyword with the above implementation with a value xxx would +fail.

      +

      In addition to validation, arguments are also converted. For example, if an +argument accepts Literal[-1, 0, 1], used arguments are converted to +integers and then validated. In addition to that, string matching is case, space, +underscore and hyphen insensitive. In all cases exact matches have a precedence +and the argument that is passed to the keyword is guaranteed to be in the exact +format used with Literal.

      +

      Literal conversion is in many ways similar to Enum conversion that Robot +Framework has supported for long time. Enum conversion has benefits like +being able to use a custom documentation and it is typically better when using +the same type multiple times. In simple cases being able to just use +arg: Literal[...] without defining a new type is very convenient, though.

      + +

      Support "stringified" types like 'list[int]' and 'int | float' +

      +

      Python's type hinting syntax has evolved so that generic types can be parameterized +like list[int] (new in Python 3.9) and unions written as int | float +(new in Python 3.10). Using these constructs with older Python versions causes +errors, but Python type checkers support also "stringified" type hints like +'list[int]' and 'int | float' that work regardless the Python version.

      +

      Support for stringified generics and unions has now been added also to +Robot Framework's argument conversion (#4711). For example, +the following typing now also works with Python 3.8:

      +
      +def example(a: 'list[int]', b: 'int | float'):
      +    ...
      +
      +

      These stringified types are also compatible with the Remote library API and other +scenarios where using actual types is not possible.

      + +

      Tags set globally can be removed using -tag syntax

      +

      Individual tests and keywords can nowadays remove tags that have been set in +the Settings section with Test Tags or Keyword Tags settings by using +the -tag syntax with their own [Tags] setting (#4374). For example, +tests T1 and T3 below get tags all and most, and test T2 gets +tags all and one:

      +
      +*** Settings ***
      +Test Tags      all    most
      +
      +*** Test Cases ***
      +T1
      +    No Operation
      +T2
      +    [Tags]    one    -most
      +    No Operation
      +T3
      +    No Operation
      +
      +

      With tests it is possible to get the same effect by using the Default Tags +setting and overriding it where needed. That syntax is, however, considered +deprecated (#4365) and using the new -tag syntax is recommended. With +keywords there was no similar functionality earlier.

      + +

      Dynamic and hybrid library APIs support asynchronous execution

      +

      Dynamic and hybrid libraries nowadays support asynchronous execution. +In practice the special methods like get_keyword_names and run_keyword +can be implemented as async methods (#4803).

      +

      Async support was added to the normal static library API in Robot Framework +6.1 (#4089). A bug related to handling asynchronous keywords if execution +is stopped gracefully has also been fixed (#4808).

      + +

      Timestamps in result model and output.xml use standard format

      +

      Timestamps used in the result model and stored to the output.xml file used custom +format like 20231107 19:57:01.123 earlier. Non-standard formats are seldom +a good idea, and in this case parsing the custom format turned out to be slow +as well.

      +

      Nowadays the result model stores timestamps as standard datetime objects and +elapsed times as a timedelta (#4258). This makes creating timestamps and +operating with them more convenient and considerably faster. The new objects can +be accessed via start_time, end_time and elapsed_time attributes that were +added as forward compatibility already in Robot Framework 6.1 (#4765). +Old information is still available via the old starttime, endtime and +elapsedtime attributes, so this change is fully backwards compatible.

      +

      The timestamp format in output.xml has also been changed from the custom +YYYYMMDD HH:MM:SS.mmm format to ISO 8601 compatible +YYYY-MM-DDTHH:MM:SS.mmmmmm. Using a standard format makes it +easier to process output.xml files, but this change also has big positive +performance effect. Now that the result model stores timestamps as datetime +objects, formatting and parsing them with the available isoformat() and +fromisoformat() methods is very fast compared to custom formatting and parsing.

      +

      A related change is that instead of storing start and end times of each executed +item in output.xml, we nowadays store their start and elapsed times. Elapsed times +are represented as floats denoting seconds. Having elapsed times directly available +is a lot more convenient than calculating them based on start and end times. +Storing start and elapsed times also takes less space than storing start and end times.

      +

      As the result of these changes, times are available in the result model and in +output.xml in higher precision than earlier. Earlier times were stored in millisecond +granularity, but nowadays they use microseconds. Logs and reports still use milliseconds, +but that can be changed in the future if there are needs.

      +

      Changes to output.xml are backwards incompatible and affect all external tools +that process timestamps. This is discussed more in Changes to output.xml +section below along with other output.xml changes.

      + +

      Dark mode support to report and log

      +

      Report and log got a new dark mode (#3725). It is enabled automatically based +on browser and operating system preferences, but there is also a toggle to +switch between the modes.

      + +

      Backwards incompatible changes

      + +

      Python 3.6 and 3.7 are no longer supported

      +

      Robot Framework 7.0 requires Python 3.8 or newer (#4294). The last version +that supports Python 3.6 and 3.7 is Robot Framework 6.1.1.

      + +

      Changes to output.xml

      +

      The output.xml file has changed in different ways making Robot Framework 7.0 +incompatible with external tools processing output.xml files until these tools +are updated. We try to avoid this kind of breaking changes, but in this case +especially the changes to timestamps were considered so important that we +eventually would have needed to do them anyway.

      +

      Due to the changes being relatively big, it can take some time before external +tools are updated. To allow users to take Robot Framework 7.0 into use also +if they depend on an incompatible tool, it is possible to use the new +--legacy-output option both as part of execution and with the Rebot tool +to generate output.xml files that are compatible with older versions.

      + +

      Timestamp related changes

      +

      The biggest changes in output.xml are related to timestamps (#4258). +With earlier versions start and end times of executed items, as well as timestamps +of the logged messages, were stored using a custom YYYYMMDD HH:MM:SS.mmm format, +but nowadays the format is ISO 8601 compatible YYYY-MM-DDTHH:MM:SS.mmmmmm. +In addition to that, instead of saving start and end times to starttime and +endtime attributes and message times to timestamp, start and elapsed times +are now stored to start and elapsed attributes and message times to time.

      +

      Examples:

      +
      +<!-- Old format -->
      +<msg timestamp="20231108 15:36:34.278" level="INFO">Hello world!</msg>
      +<status status="PASS" starttime="20231108 15:37:35.046" endtime="20231108 15:37:35.046"/>
      +
      +<!-- New format -->
      +<msg time="2023-11-08T15:36:34.278343" level="INFO">Hello world!</msg>
      +<status status="PASS" start="2023-11-08T15:37:35.046153" elapsed="0.000161"/>
      +
      +

      The new format is standard compliant, contains more detailed times, makes the elapsed +time directly available and makes the <status> elements over 10% shorter. +These are all great benefits, but we are still sorry for all the extra work +this causes for those developing tools that process output.xml files.

      + +

      Keyword name related changes

      +

      How keyword names are stored in output.xml has changed slightly (#4884). +With each executed keywords we store both the name of the keyword and the name +of the library or resource file containing it. Earlier the latter was stored to +attribute library also with resource files, but nowadays the attribute is generic +owner. In addition to owner being a better name in general, it also +matches the new owner attribute keywords in the result model have.

      +

      Another change is that the original name stored with keywords using embedded +arguments is nowadays in source_name attribute when it used to be in sourcename. +This change was done to make the attribute consistent with the attribute in +the result model.

      +

      Examples:

      +
      +<!-- Old format -->
      +<kw name="Log" library="BuiltIn">...</kw>
      +<kw name="Number of horses should be" sourcename="Number of ${animals} should be" library="my_resource">...</kw>
      +
      +<!-- New format -->
      +<kw name="Log" owner="BuiltIn">...</kw>
      +<kw name="Number of horses should be" source_name="Number of ${animals} should be" owner="my_resource">...</kw>
      +
      + +

      Other changes

      +

      Nowadays keywords and control structures can have a message. Messages are represented +as the text of the <status> element, and they have been present already earlier with +tests and suites. Related to this, control structured cannot anymore have <doc>. +(#4883)

      +

      These changes should not cause problems for tools processing output.xml files, +but storing messages with each failed keyword and control structure may +increase the output.xml size.

      + +

      Schema updates

      +

      The output.xml schema has been updated and can be found via +https://github.com/robotframework/robotframework/tree/master/doc/schema/.

      + +

      Changes to result model

      +

      There have been some changes to the result model that unfortunately affect +external tools using it. The main motivation for these changes has been +cleaning up the model before creating a JSON representation for it (#4847).

      + +

      Changes related to keyword names

      +

      The biggest changes are related to keyword names (#4884). Earlier Keyword +objects had a name attribute that contained the full keyword name like +BuiltIn.Log. The actual keyword name and the name of the library or resource +file that the keyword belonged to were in kwname and libname attributes, +respectively. In addition to these, keywords using embedded arguments also had +a sourcename attribute containing the original keyword name.

      +

      Due to reasons explained in #4884, the following changes have been made +in Robot Framework 7.0:

      +
        +
      • Old kwname is renamed to name. This is consistent with the execution side Keyword.
      • +
      • Old libname is renamed to generic owner.
      • +
      • New full_name is introduced to replace the old name.
      • +
      • +sourcename is renamed to source_name.
      • +
      • +kwname, libname and sourcename are preserved as properties. They are considered +deprecated, but accessing them does not cause a deprecation warning yet.
      • +
      +

      The backwards incompatible part of this change is changing the meaning of the +name attribute. It used to be a read-only property yielding the full name +like BuiltIn.Log, but now it is a normal attribute that contains just the actual +keyword name like Log. All other old attributes have been preserved as properties +and code using them does not need to be updated immediately.

      + +

      Deprecated attributes have been removed

      +

      The following attributes that were deprecated already in Robot Framework 4.0 +have been removed (#4846):

      +
        +
      • +TestSuite.keywords. Use TestSuite.setup and TestSuite.teardown instead.
      • +
      • +TestCase.keywords. Use TestCase.body, TestCase.setup and TestCase.teardown instead.
      • +
      • +Keyword.keywords. Use Keyword.body and Keyword.teardown instead.
      • +
      • +Keyword.children. Use Keyword.body and Keyword.teardown instead.
      • +
      • +TestCase.critical. The whole criticality concept has been removed.
      • +
      +

      Additionally, TestSuite.keywords and TestCase.keywords have been removed +from the execution model.

      + +

      Changes to parsing model

      +

      There have been some changes also to the parsing model:

      +
        +
      • +

        The node representing the deprecated [Return] setting has been renamed from +Return to ReturnSetting. At the same time, the node representing the +RETURN statement has been renamed from ReturnStatement to Return (#4939).

        +

        To ease transition, ReturnSetting has existed as an alias for Return starting +from Robot Framework 6.1 (#4656) and ReturnStatement is preserved as an alias +now. In addition to that, the ModelVisitor base class has special handling for +visit_ReturnSetting and visit_ReturnStatement visitor methods so that they work +correctly with ReturnSetting and ReturnStatement with Robot Framework 6.1 and +newer. Issue #4939 explains this in more detail and has a concrete example +how to support also older Robot Framework versions.

        +
      • +
      • +

        The node representing the Test Tags setting as well as the deprecated +Force Tags setting has been renamed from ForceTags to TestTags (#4385). +ModelVisitor has special handling for the visit_ForceTags method so +that it will continue to work also after the change.

        +
      • +
      • +

        The token type used with AS (or WITH NAME) in library imports has been changed +to Token.AS (#4375). Token.WITH_NAME still exists as an alias for Token.AS.

        +
      • +
      • +

        Statement type and tokens have been moved from _fields to _attributes (#4912). +This may affect debugging the model.

        +
      • +
      + +

      Changes to Libdoc spec files

      +

      The following deprecated constructs have been removed from Libdoc spec files (#4667):

      +
        +
      • +datatypes have been removed from XML or JSON spec files. They were deprecated in +favor of typedocs already in Robot Framework 5.0 (#4160).
      • +
      • Type names are not anymore written to XML specs as content of the <type> elements. +The name is available as the name attribute of <type> elements since +Robot Framework 6.1 (#4538).
      • +
      • +types and typedocs attributes have been removed from arguments in JSON specs. +The type attribute introduced in RF 6.1 (#4538) needs to be used instead.
      • +
      +

      Libdoc schema files have been updated and can be found via +https://github.com/robotframework/robotframework/tree/master/doc/schema/.

      + +

      Changes to selecting tests with --suite, --test and --include

      +

      There are two changes related to selecting tests:

      +
        +
      • When using --test and --include together, tests matching either of them +are selected (#4721). Earlier tests need to match both options to be selected.
      • +
      • When selecting a suite using its parent suite as a prefix like --suite parent.suite, +the given name must match the full suite name (#4720). Earlier it was enough if +the prefix matched the closest parent or parents.
      • +
      + +

      Other backwards incompatible changes

      +
        +
      • The default value of the stdin argument used with Process library keyword +has been changed from subprocess.PIPE to None (#4103). This change ought +to avoid processes hanging in some cases. Those who depend on the old behavior +need to use stdin=PIPE explicitly to enable that.
      • +
      • When type hints are specified as strings, they must use format type, type[param], +type[p1, p2] or t1 | t2 (#4711). Using other formats will cause errors taking +keywords into use. In practice problems occur if the special characters [, ], , +and | occur in unexpected places. For example, arg: "Hello, world!" will cause +an error due to the comma.
      • +
      • +datetime, date and timedelta objects are sent over the Remote interface +differently than earlier (#4784). They all used to be converted to strings, but +nowadays datetime is sent as-is, date is converted to datetime and sent like +that, and timedelta is converted to a float by using timedelta.total_seconds().
      • +
      • Argument conversion support with collections.abc.ByteString has been removed (#4983). +The reason is that ByteString is deprecated and will be removed in Python 3.14. +It has not been too often needed, but if you happen to use it, you can change +arg: ByteString to arg: bytes | bytearray and the functionality +stays exactly the same.
      • +
      • Paths passed to result file related listener version 3 methods like output_file +and log_file have been changed from strings to pathlib.Path objects (#4988). +Most of the time both kinds of paths work interchangeably, so this change is unlikely +to cause issues. If you need to handle these paths as strings, they can be converted +by using str(path).
      • +
      • +robot.utils.normalize does not anymore support bytes (#4936).
      • +
      • Deprecated accept_plain_values argument has been removed from the +timestr_to_secs utility function (#4861).
      • +
      + +

      Deprecations

      + +

      [Return] setting

      +

      The [Return] setting for specifying the return value from user keywords has +been "loudly" deprecated (#4876). It has been "silently" deprecated since +Robot Framework 5.0 when the much more versatile RETURN setting was introduced +(#4078), but now using it will cause a deprecation warning. The plan is to +preserve the [Return] setting at least until Robot Framework 8.0.

      +

      If you have lot of data that uses [Return], the easiest way to update it is +using the Robotidy tool that can convert [Return] to RETURN automatically. +If you have data that is executed also with Robot Framework versions that do +not support RETURN, you can use the Return From Keyword keyword instead. +That keyword will eventually be deprecated and removed as well, though.

      + +

      Singular section headers

      +

      Using singular section headers like *** Test Case *** or *** Setting *** +nowadays causes a deprecation warning (#4432). They were silently deprecated +in Robot Framework 6.0 for reasons explained in issue #4431.

      + +

      Deprecated attributes in parsing, running and result models

      +
        +
      • In the parsing model, For.variables, ForHeader.variables, Try.variable and +ExceptHeader.variable attributes have been deprecated in favor of the new assign +attribute (#4708).
      • +
      • In running and result models, For.variables and TryBranch.variable have been +deprecated in favor of the new assign attribute (#4708).
      • +
      • In the result model, control structures like FOR were earlier modeled so that they +looked like keywords. Nowadays they are considered totally different objects and +their keyword specific attributes name, kwnane, libname, doc, args, +assign, tags and timeout have been deprecated (#4846).
      • +
      • +starttime, endtime and elapsed time attributes in the result model have been +silently deprecated (#4258). Accessing them does not yet cause a deprecation +warning, but users are recommended to use start_time, end_time and +elapsed_time attributes that are available since Robot Framework 6.1.
      • +
      • +kwname, libname and sourcename attributes used by the Keyword object +in the result model have been silently deprecated (#4884). New code should use +name, owner and source_name instead.
      • +
      + +

      Other deprecated features

      +
        +
      • Using embedded arguments with a variable that has a value not matching custom +embedded argument patterns nowadays causes a deprecation warning (#4524). +Earlier variables used as embedded arguments were always accepted without +validating values.
      • +
      • Using FOR IN ZIP loops with lists having different lengths without explicitly +using mode=SHORTEST has been deprecated (#4685). The strict mode where lengths +must match will be the default mode in the future.
      • +
      • Various utility functions in the robot.utils package that are no longer used +by Robot Framework itself, including the whole Python 2/3 compatibility layer, +have been deprecated (#4501). If you need some of these utils, you can copy +their code to your own tool or library. This change may affect existing +libraries and tools in the ecosystem.
      • +
      • +case_insensitive and whitespace_insensitive arguments used by some +Collections and String library keywords have been deprecated in favor of +ignore_case and ignore_whitespace. The new arguments were added for +consistency reasons (#4954) and the old arguments will continue to work +for the time being.
      • +
      • Passing time as milliseconds to the elapsed_time_to_string utility function +has been deprecated (#4862).
      • +
      + +

      Acknowledgements

      +

      Robot Framework development is sponsored by the Robot Framework Foundation +and its over 60 member organizations. If your organization is using Robot Framework +and benefiting from it, consider joining the foundation to support its +development as well.

      +

      Robot Framework 7.0 team funded by the foundation consists of Pekka Klärck and +Janne Härkönen (part time). +In addition to work done by them, the community has provided some great contributions:

      +
        +
      • +Ygor Pontelo added async support to the +dynamic and hybrid library APIs (#4803) and fixed a bug with handling async +keywords when execution is stopped gracefully (#4808).
      • +
      • +Topi 'top1' Tuulensuu fixed a performance regression +when using Run Keyword so that the name of the executed keyword contains a variable +(#4659).
      • +
      • +Pasi Saikkonen added dark mode to reports +and logs (#3725).
      • +
      • +René added return type information to Libdoc's +HTML output (#3017), fixed DotDict equality comparisons (#4956) and +helped finalizing the dark mode support (#3725).
      • +
      • +Robin added type hints to modules that +did not yet have them under the public robot.api package (#4841).
      • +
      • +Mark Moberts added case-insensitive list and +dictionary comparison support to the Collections library (#4343).
      • +
      • +Daniel Biehl enhanced performance of traversing +the parsing model using ModelVisitor (#4934).
      • +
      +

      Big thanks to Robot Framework Foundation, to community members listed above, and to +everyone else who has tested preview releases, submitted bug reports, proposed +enhancements, debugged problems, or otherwise helped with Robot Framework 7.0 +development.

      +

      See you at RoboCon 2024 either onsite or online!

      +
      + +
      Robot Framework lead developer
      +
      + +

      Full list of fixes and enhancements

      +
      + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
      IDTypePrioritySummary
      #3296enhancementcriticalSupport keywords and control structures with listener version 3
      #3761enhancementcriticalNative VAR syntax to create variables inside tests and keywords
      #4294enhancementcriticalDrop Python 3.6 and 3.7 support
      #4710enhancementcriticalSupport library keywords with both embedded and normal arguments
      #4847enhancementcriticalSupport JSON serialization with result model
      #4659bughighPerformance regression when using Run Keyword and keyword name contains a variable
      #4921bughighLog levels don't work correctly with robot:flatten +
      #3725enhancementhighSupport dark theme with report and log
      #4258enhancementhighChange timestamps from custom strings to datetime in result model and to ISO 8601 format in output.xml
      #4374enhancementhighSupport removing tags set globally by using -tag syntax with [Tags] setting
      #4633enhancementhighAutomatic argument conversion and validation for Literal +
      #4711enhancementhighSupport type aliases in formats 'list[int]' and 'int | float' in argument conversion
      #4803enhancementhighAsync support to dynamic and hybrid library APIs
      #4808bugmediumAsync keywords are not stopped when execution is stopped gracefully
      #4859bugmediumParsing errors in reStructuredText files have no source
      #4880bugmediumInitially empty test fails even if pre-run modifier adds content to it
      #4886bugmedium +Set Variable If is slow if it has several conditions
      #4898bugmediumResolving special variables can fail with confusing message
      #4915bugmedium +cached_property attributes are called when importing library
      #4924bugmediumWHILE on_limit missing from listener v2 attributes
      #4926bugmediumWHILE and TRY content are not removed with --removekeywords all +
      #4945bugmedium +TypedDict with forward references do not work in argument conversion
      #4956bugmediumDotDict behaves inconsistent on equality checks. x == y != not x != y and not x != y == not x == y +
      #4964bugmediumVariables set using Set Suite Variable with children=True cannot be properly overwritten
      #4980bugmediumDateTime library uses deprecated datetime.utcnow() +
      #4999bugmediumXML Library: Double namespace during Element To String
      #5005bugmedium +Log Variables should not consume iterables
      #3017enhancementmediumAdd return type to Libdoc specs and HTML output
      #4103enhancementmediumProcess: Change the default stdin behavior from subprocess.PIPE to None +
      #4302enhancementmediumRemove Reserved library
      #4343enhancementmediumCollections: Support case-insensitive list and dictionary comparisons
      #4375enhancementmediumChange token type of AS (or WITH NAME) used with library imports to Token.AS +
      #4385enhancementmediumChange the parsing model object produced by Test Tags (and Force Tags) to TestTags +
      #4432enhancementmediumLoudly deprecate singular section headers
      #4501enhancementmediumLoudly deprecate old Python 2/3 compatibility layer and other deprecated utils
      #4524enhancementmediumLoudly deprecate variables used as embedded arguments not matching custom patterns
      #4545enhancementmediumSupport creating assigned variable name based on another variable like ${${var}} = Keyword +
      #4667enhancementmediumRemove deprecated constructs from Libdoc spec files
      #4685enhancementmediumDeprecate SHORTEST mode being default with FOR IN ZIP loops
      #4708enhancementmediumUse assing, not variable, with FOR and TRY/EXCEPT model objects when referring to assigned variables
      #4720enhancementmediumRequire --suite parent.suite to match the full suite name
      #4721enhancementmediumChange behavior of --test and --include so that they are cumulative
      #4747enhancementmediumSupport [Setup] with user keywords
      #4784enhancementmediumRemote: Enhance datetime, date and timedelta conversion
      #4841enhancementmediumAdd typing to all modules under robot.api +
      #4846enhancementmediumResult model: Loudly deprecate not needed attributes and remove already deprecated ones
      #4872enhancementmediumControl continue-on-failure mode by using recursive and non-recursive tags together
      #4876enhancementmediumLoudly deprecate [Return] setting
      #4877enhancementmediumXML: Support ignoring element order with Elements Should Be Equal +
      #4883enhancementmediumResult model: Add message to keywords and control structures and remove doc from controls
      #4884enhancementmediumResult model: Enhance storing keyword name
      #4896enhancementmediumSupport separator=<value> configuration option with scalar variables in Variables section
      #4903enhancementmediumSupport argument conversion and named arguments with dynamic variable files
      #4905enhancementmediumSupport creating variable name based on another variable like ${${VAR}} in Variables section
      #4910enhancementmediumMake listener v3 the default listener API
      #4912enhancementmediumParsing model: Move type and tokens from _fields to _attributes +
      #4930enhancementmediumBuiltIn: New Reset Log Level keyword for resetting the log level to the original value
      #4939enhancementmediumParsing model: Rename Return to ReturnSetting and ReturnStatement to Return +
      #4942enhancementmediumAdd public argument conversion API for libraries and other tools
      #4952enhancementmediumCollections: Make ignore_order and ignore_keys recursive
      #4960enhancementmediumSupport integer conversion with strings representing whole number floats like '1.0' and '2e10' +
      #4976enhancementmediumSupport string SELF (case-insenstive) when library registers itself as listener
      #4979enhancementmediumAdd robot.result.TestSuite.to/from_xml methods
      #4982enhancementmediumDateTime: Support datetime.date as an input format with date related keywords
      #4983enhancementmediumType conversion: Remove support for deprecated ByteString +
      #5000enhancementmediumNicer API for setting keyword call arguments programmatically
      #4934---mediumEnhance performance of visiting parsing model
      #4621buglowOperatingSystem library docs have broken link / title
      #4798buglow +--removekeywords passed doesn't remove test setup and teardown
      #4867buglowOriginal order of dictionaries is not preserved when they are pretty printed in log messages
      #4870buglowUser keyword teardown missing from running model JSON schema
      #4904buglowImporting static variable file with arguments does not fail
      #4913buglowTrace log level logs arguments twice for embedded arguments
      #4927buglowWARN level missing from the log level selector in log.html
      #4967buglowVariables are not resolved in keyword name in WUKS error message
      #4861enhancementlowRemove deprecated accept_plain_values from timestr_to_secs utility function
      #4862enhancementlowDeprecate elapsed_time_to_string accepting time as milliseconds
      #4864enhancementlowProcess: Make warning about processes hanging if output buffers get full more visible
      #4885enhancementlowAdd full_name to replace longname to suite and test objects
      #4900enhancementlowMake keywords and control structures in log look more like original data
      #4922enhancementlowChange the log level of Set Log Level message from INFO to DEBUG
      #4933enhancementlowType conversion: Ignore hyphens when matching enum members
      #4935enhancementlowUse casefold, not lower, when comparing strings case-insensitively
      #4936enhancementlowRemove bytes support from robot.utils.normalize function
      #4954enhancementlowCollections and String: Add ignore_case as alias for case_insensitive +
      #4958enhancementlowDocument robot_running and dry_run_active properties of the BuiltIn library in the User Guide
      #4975enhancementlowSupport times and x suffixes with WHILE limit to make it more compatible with Wait Until Keyword Succeeds +
      #4988enhancementlowChange paths passed to listener v3 methods to pathlib.Path instances
      +

      Altogether 88 issues. View on the issue tracker.

      \ No newline at end of file diff --git a/test/markups/README.mediawiki.html b/test/markups/README.mediawiki.html index fcc56bfe..e92accfd 100644 --- a/test/markups/README.mediawiki.html +++ b/test/markups/README.mediawiki.html @@ -15,18 +15,20 @@

      -Red Bridge (JRuby Embed)

      +Red Bridge (JRuby Embed) + +

      one-<two

      a-b
      -

      JRuby has long had a private embedding API, which was closely tied to the runtime's internals and therefore changed frequently as JRuby evolved. Since version 1.4, however, we have also provided a more stable public API, known as Red Bridge or JRuby Embed. Existing Java programs written to the legacy API should still work, but we strongly recommend Red Bridge for all new projects.

      -Features of Red Bridge

      +Features of Red Bridge +

      Red Bridge consists of two layers: Embed Core on the bottom, and implementations of JSR223 and BSF on top. Embed Core is JRuby-specific, and can take advantage of much of JRuby's power. JSR223 and BSF are more general interfaces that provide a common ground across scripting languages. @@ -46,14 +48,16 @@

      -Previous Embedding JRuby Page

      +Previous Embedding JRuby Page +

      We recommend using Embed Core; however, if you're maintaining code that uses the old API, you can find its documentation on the legacy embedding[1] page.

      -References

      +References +

      1. diff --git a/test/markups/README.pod.html b/test/markups/README.pod.html index a62c65db..63caf6bc 100644 --- a/test/markups/README.pod.html +++ b/test/markups/README.pod.html @@ -10,7 +10,8 @@

        ABOUT

          -
        • Create a working compiler that understands the majority of the MATLAB/Octave programming language.

          +
        • +

          Create a working compiler that understands the majority of the MATLAB/Octave programming language.

        @@ -21,13 +22,16 @@

        IMPLEMENTATION

          -
        • The first is the parser, located in the src/parser/ directory. The parser proper is composed of three source files, grammar.pg which is a Perl6Grammar file, and actions.pm which is the associated actions file written in NQP, and grammar-oper.pm which is the operator precedence parser. In addition, several helper functions used by the parser are located in src/internals.

          +
        • +

          The first is the parser, located in the src/parser/ directory. The parser proper is composed of three source files, grammar.pg which is a Perl6Grammar file, and actions.pm which is the associated actions file written in NQP, and grammar-oper.pm which is the operator precedence parser. In addition, several helper functions used by the parser are located in src/internals.

        • -
        • The second component is the library of builtin functions in the src/builtins/ directory. These functions are, currently, written primarily in PIR. Function names prefixed with an underscore are "private" functions for use with the parser. Other functions should have names which are the same as names for regular MATLAB or Octave functions, since they will be available to the HLL. These are also separated into different namespaces depending on visibility and utility.

          +
        • +

          The second component is the library of builtin functions in the src/builtins/ directory. These functions are, currently, written primarily in PIR. Function names prefixed with an underscore are "private" functions for use with the parser. Other functions should have names which are the same as names for regular MATLAB or Octave functions, since they will be available to the HLL. These are also separated into different namespaces depending on visibility and utility.

        • -
        • A number of library functions are written in M, or mostly M with some inline PIR code in toolbox/.

          +
        • +

          A number of library functions are written in M, or mostly M with some inline PIR code in toolbox/.

        diff --git a/test/markups/README.rst.html b/test/markups/README.rst.html index 6accfdf6..f87a8065 100644 --- a/test/markups/README.rst.html +++ b/test/markups/README.rst.html @@ -2,7 +2,7 @@

        Header 1

        Subtitle

        Example text.

        -

        Table of Contents

        +

        Table of Contents

        • Header 2
        • Field list
        • @@ -102,7 +102,8 @@

          Header 2

          -Coverity Scan Build Status + +Coverity Scan Build Status Coverity Scan Build Status @@ -133,5 +134,4 @@

          Field list

          someone@somewhere.org

          Press Ctrl+C to quit

          - -

          RAW HTML!

          p {color:blue;} \ No newline at end of file +

          RAW HTML!

          p {color:blue;} \ No newline at end of file diff --git a/test/markups/README.toc.asciidoc.html b/test/markups/README.toc.asciidoc.html index e6f598cf..4e32869a 100644 --- a/test/markups/README.toc.asciidoc.html +++ b/test/markups/README.toc.asciidoc.html @@ -43,4 +43,4 @@

          Subsection B-2

        - + \ No newline at end of file diff --git a/test/markups/README.toc.rst.html b/test/markups/README.toc.rst.html index 4890e99b..c5b3ecbb 100644 --- a/test/markups/README.toc.rst.html +++ b/test/markups/README.toc.rst.html @@ -1,5 +1,5 @@
        -

        Contents

        +

        Contents

        • 1   Introduction
            @@ -29,4 +29,4 @@

            1.2   What is it good for?

          pycparser is unique in the sense that it's written in pure Python - a very high level language that's easy to experiment with and tweak. To people familiar -with Lex and Yacc, pycparser's code will be simple to understand.

          +with Lex and Yacc, pycparser's code will be simple to understand.

          \ No newline at end of file From 2e6d49d58f2bc9397dc2ebe7d2aa474353357402 Mon Sep 17 00:00:00 2001 From: Justin Kenyon Date: Mon, 17 Jun 2024 11:07:35 -0400 Subject: [PATCH 12/34] Update HISTORY.md --- HISTORY.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/HISTORY.md b/HISTORY.md index ace518d1..0e01f49c 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,4 +1,4 @@ -## 5.0.0 - 2024-06-12 +## 5.0.0 - 2024-06-17 * Drop support for Ruby versions < 3 * Bump nokogiri from 1.8.1 to 1.16.5 * Bump nokogiri-diff from 0.2.0 to 0.3.0 From aa09a8a8d4d8fa7752500fa063802e4aba89cda3 Mon Sep 17 00:00:00 2001 From: Justin Kenyon Date: Mon, 17 Jun 2024 11:18:26 -0400 Subject: [PATCH 13/34] Update activesupport to 7.1.3.4 --- .gitignore | 1 + github-markup.gemspec | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index c93c0b18..5e84e6f2 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,4 @@ Gemfile.lock .buildpath *~ vendor/ +.DS_Store diff --git a/github-markup.gemspec b/github-markup.gemspec index 4818706d..260df18c 100644 --- a/github-markup.gemspec +++ b/github-markup.gemspec @@ -21,7 +21,7 @@ Gem::Specification.new do |s| s.require_paths = %w[lib] s.add_development_dependency 'rake', '~> 12' - s.add_development_dependency 'activesupport', '~> 4.0' + s.add_development_dependency 'activesupport', '~> 7.1.3.4' s.add_development_dependency 'minitest', '~> 5.4', '>= 5.4.3' s.add_development_dependency 'html-pipeline', '~> 1.0' s.add_development_dependency 'sanitize', '>= 4.6.3' From 26b77f5d7c86c2f6f307491e946035424ae62e9e Mon Sep 17 00:00:00 2001 From: Justin Kenyon Date: Mon, 17 Jun 2024 11:20:56 -0400 Subject: [PATCH 14/34] update version and history --- HISTORY.md | 3 +++ lib/github-markup.rb | 2 +- 2 files changed, 4 insertions(+), 1 deletion(-) diff --git a/HISTORY.md b/HISTORY.md index 0e01f49c..745a9c1b 100644 --- a/HISTORY.md +++ b/HISTORY.md @@ -1,3 +1,6 @@ +## 5.0.1 - 2024-06-17 +* Bump activesupport from 4.0 to 7.1.3.4 + ## 5.0.0 - 2024-06-17 * Drop support for Ruby versions < 3 * Bump nokogiri from 1.8.1 to 1.16.5 diff --git a/lib/github-markup.rb b/lib/github-markup.rb index 646e341c..7c36ad17 100644 --- a/lib/github-markup.rb +++ b/lib/github-markup.rb @@ -1,6 +1,6 @@ module GitHub module Markup - VERSION = '5.0.0' + VERSION = '5.0.1' Version = VERSION end end From e6973dfdacfb5d124fc45fdef2a6467d91ac3aa8 Mon Sep 17 00:00:00 2001 From: jmeridth Date: Mon, 17 Jun 2024 10:44:53 -0500 Subject: [PATCH 15/34] chore: add dependabot and update github actions Closes #1756 - [x] update github actions to latest versions - [x] use SHAs instead of tags for github actions, more secure supply chain - [x] add dependabot file grouping minor/patch dependency updates to reduce PRs - [x] remove Gemfile.lock from .gitignore and add it back to source control - this will allow dependabot to detect dependency updates Signed-off-by: jmeridth Co-authored-by: Zack Koppert --- .github/dependabot.yaml | 39 +++++++++++ .github/workflows/ci.yml | 8 +-- .gitignore | 1 - Gemfile.lock | 135 +++++++++++++++++++++++++++++++++++++++ 4 files changed, 178 insertions(+), 5 deletions(-) create mode 100644 .github/dependabot.yaml create mode 100644 Gemfile.lock diff --git a/.github/dependabot.yaml b/.github/dependabot.yaml new file mode 100644 index 00000000..802b7513 --- /dev/null +++ b/.github/dependabot.yaml @@ -0,0 +1,39 @@ +--- +version: 2 +updates: + - package-ecosystem: 'bundler' + directory: '/' + schedule: + interval: 'weekly' + commit-message: + prefix: 'chore(deps)' + groups: + dependencies: + applies-to: version-updates + update-types: + - 'minor' + - 'patch' + - package-ecosystem: 'github-actions' + directory: '/' + schedule: + interval: 'weekly' + commit-message: + prefix: 'chore(deps)' + groups: + dependencies: + applies-to: version-updates + update-types: + - 'minor' + - 'patch' + - package-ecosystem: 'docker' + directory: '/' + schedule: + interval: 'weekly' + commit-message: + prefix: 'chore(deps)' + groups: + dependencies: + applies-to: version-updates + update-types: + - 'minor' + - 'patch' diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index a25fdefc..e0feed3c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -19,21 +19,21 @@ jobs: steps: - name: Checkout - uses: actions/checkout@v2 + uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4 with: fetch-depth: 10 - - uses: ruby/setup-ruby@v1 + - uses: ruby/setup-ruby@ff740bc00a01b3a50fffc55a1071b1060eeae9dc # v1 with: ruby-version: ${{ matrix.ruby }} bundler-cache: true - - uses: actions/setup-python@v2 + - uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5 with: # This should match lib/github/markups.rb GitHub::Markups::MARKUP_RST python-version: '3.x' - - uses: actions/cache@v2 + - uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4 with: path: ~/.cache/pip key: ${{ runner.os }}-pip diff --git a/.gitignore b/.gitignore index 5e84e6f2..eac4d715 100644 --- a/.gitignore +++ b/.gitignore @@ -1,7 +1,6 @@ *.pyc pkg/ .bundle -Gemfile.lock .project .buildpath *~ diff --git a/Gemfile.lock b/Gemfile.lock new file mode 100644 index 00000000..225b59a6 --- /dev/null +++ b/Gemfile.lock @@ -0,0 +1,135 @@ +GIT + remote: https://github.com/gjtorikian/commonmarker.git + revision: 2838ebaa83ee0081d481c21f3bc0e4cb3e8de9da + tag: v0.18.3 + specs: + commonmarker (0.18.3) + ruby-enum (~> 0.5) + +PATH + remote: . + specs: + github-markup (5.0.1) + +GEM + remote: http://rubygems.org/ + specs: + RedCloth (4.3.4) + activesupport (7.1.3.4) + base64 + bigdecimal + concurrent-ruby (~> 1.0, >= 1.0.2) + connection_pool (>= 2.2.5) + drb + i18n (>= 1.6, < 2) + minitest (>= 5.1) + mutex_m + tzinfo (~> 2.0) + asciidoctor (2.0.23) + base64 (0.2.0) + bigdecimal (3.1.8) + builder (3.3.0) + cgi (0.4.1) + charlock_holmes (0.7.7) + concurrent-ruby (1.3.3) + connection_pool (2.4.1) + crass (1.0.6) + creole (0.3.8) + drb (2.2.1) + expression_parser (0.9.0) + github-linguist (7.30.0) + cgi + charlock_holmes (~> 0.7.7) + mini_mime (~> 1.0) + rugged (~> 1.0) + html-pipeline (1.11.0) + activesupport (>= 2) + nokogiri (~> 1.4) + htmlentities (4.3.4) + i18n (1.14.5) + concurrent-ruby (~> 1.0) + mini_mime (1.1.5) + minitest (5.23.1) + mutex_m (0.2.0) + nokogiri (1.16.6-aarch64-linux) + racc (~> 1.4) + nokogiri (1.16.6-arm-linux) + racc (~> 1.4) + nokogiri (1.16.6-arm64-darwin) + racc (~> 1.4) + nokogiri (1.16.6-x86-linux) + racc (~> 1.4) + nokogiri (1.16.6-x86_64-darwin) + racc (~> 1.4) + nokogiri (1.16.6-x86_64-linux) + racc (~> 1.4) + nokogiri-diff (0.3.0) + nokogiri (~> 1.5) + tdiff (~> 0.4) + org-ruby (0.9.9) + rubypants (~> 0.2) + psych (5.1.2) + stringio + racc (1.8.0) + rake (13.2.1) + rdoc (6.7.0) + psych (>= 4.0.0) + redcarpet (3.6.0) + rexml (3.3.0) + strscan + ruby-enum (0.9.0) + i18n + rubypants (0.7.1) + rugged (1.7.2) + sanitize (6.1.1) + crass (~> 1.0.2) + nokogiri (>= 1.12.0) + stringio (3.1.1) + strscan (3.1.0) + tdiff (0.4.0) + twitter-text (1.14.7) + unf (~> 0.1.0) + tzinfo (2.0.6) + concurrent-ruby (~> 1.0) + unf (0.1.4) + unf_ext + unf_ext (0.0.9.1) + wikicloth (0.8.3) + builder + expression_parser + htmlentities + nokogiri + twitter-text + +PLATFORMS + aarch64-linux + arm-linux + arm64-darwin + x86-linux + x86_64-darwin + x86_64-linux + +DEPENDENCIES + RedCloth + activesupport (~> 7.1.3.4) + asciidoctor (~> 2.0.5) + commonmarker! + creole (~> 0.3.6) + github-linguist (>= 7.1.3) + github-markup! + html-pipeline (~> 1.0) + kramdown + minitest (~> 5.4, >= 5.4.3) + nokogiri (~> 1.16.5) + nokogiri-diff (~> 0.3.0) + org-ruby (= 0.9.9) + rake + rdoc (~> 6.7.0) + redcarpet + rexml + sanitize (>= 4.6.3) + twitter-text (~> 1.14) + wikicloth (= 0.8.3) + +BUNDLED WITH + 2.5.9 From 06e35c7cd36c297d220a07118b6b89cc925d0843 Mon Sep 17 00:00:00 2001 From: Justin Kenyon Date: Wed, 19 Jun 2024 15:36:52 -0400 Subject: [PATCH 16/34] Create stale.yml --- .github/workflows/stale.yml | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 .github/workflows/stale.yml diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml new file mode 100644 index 00000000..6bf0d0b6 --- /dev/null +++ b/.github/workflows/stale.yml @@ -0,0 +1,27 @@ +# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time. +# +# You can adjust the behavior by modifying this file. +# For more information, see: +# https://github.com/actions/stale +name: Mark stale issues and pull requests + +on: + schedule: + - cron: '0 12 * * *' + +jobs: + stale: + + runs-on: ubuntu-latest + permissions: + issues: write + pull-requests: write + + steps: + - uses: actions/stale@v5 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + stale-issue-message: 'Stale issue message' + stale-pr-message: 'Stale pull request message' + stale-issue-label: 'no-issue-activity' + stale-pr-label: 'no-pr-activity' From 2a0c8ddb79d66be5d03e8618896b2f1db89e82a9 Mon Sep 17 00:00:00 2001 From: jmeridth Date: Wed, 19 Jun 2024 15:33:14 -0500 Subject: [PATCH 17/34] chore: use sha instead of tag on stale workflow didn't catch this in #1821 Using SHA instead of tag ensures secure supply chain. Tags are mutable, SHAs are not Signed-off-by: jmeridth --- .github/workflows/stale.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 6bf0d0b6..6f52b5d0 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -18,7 +18,7 @@ jobs: pull-requests: write steps: - - uses: actions/stale@v5 + - uses: actions/stale@f7176fd3007623b69d27091f9b9d4ab7995f0a06 # v5 with: repo-token: ${{ secrets.GITHUB_TOKEN }} stale-issue-message: 'Stale issue message' From 7e6c70341e46d0212a811a259f4706d88e9629fa Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Wed, 17 Jul 2024 00:03:10 +0000 Subject: [PATCH 18/34] chore(deps): bump rexml from 3.3.0 to 3.3.2 in the bundler group Bumps the bundler group with 1 update: [rexml](https://github.com/ruby/rexml). Updates `rexml` from 3.3.0 to 3.3.2 - [Release notes](https://github.com/ruby/rexml/releases) - [Changelog](https://github.com/ruby/rexml/blob/master/NEWS.md) - [Commits](https://github.com/ruby/rexml/compare/v3.3.0...v3.3.2) --- updated-dependencies: - dependency-name: rexml dependency-type: direct:production dependency-group: bundler ... Signed-off-by: dependabot[bot] --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index 225b59a6..30c4454c 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -75,7 +75,7 @@ GEM rdoc (6.7.0) psych (>= 4.0.0) redcarpet (3.6.0) - rexml (3.3.0) + rexml (3.3.2) strscan ruby-enum (0.9.0) i18n From 2b0455a36cda769a2da7df1e29cb77143d1bd3f7 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Fri, 2 Aug 2024 16:46:51 +0000 Subject: [PATCH 19/34] chore(deps): bump rexml from 3.3.2 to 3.3.3 in the bundler group Bumps the bundler group with 1 update: [rexml](https://github.com/ruby/rexml). Updates `rexml` from 3.3.2 to 3.3.3 - [Release notes](https://github.com/ruby/rexml/releases) - [Changelog](https://github.com/ruby/rexml/blob/master/NEWS.md) - [Commits](https://github.com/ruby/rexml/compare/v3.3.2...v3.3.3) --- updated-dependencies: - dependency-name: rexml dependency-type: direct:production dependency-group: bundler ... Signed-off-by: dependabot[bot] --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index 30c4454c..9a4cdb41 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -75,7 +75,7 @@ GEM rdoc (6.7.0) psych (>= 4.0.0) redcarpet (3.6.0) - rexml (3.3.2) + rexml (3.3.3) strscan ruby-enum (0.9.0) i18n From 83b09f8186a3f364c537726c3cfaa3a62924f8bc Mon Sep 17 00:00:00 2001 From: jmeridth Date: Tue, 6 Aug 2024 15:05:30 -0500 Subject: [PATCH 20/34] fix: ensure rubygems url is using https Fixes https://github.com/github/markup/security/code-scanning/1 `Dependency source URL uses the unencrypted protocol HTTP. Use HTTPS instead.` Signed-off-by: jmeridth --- Gemfile | 2 +- Gemfile.lock | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/Gemfile b/Gemfile index fb3c1308..9b317555 100644 --- a/Gemfile +++ b/Gemfile @@ -1,4 +1,4 @@ -source "http://rubygems.org" +source "https://rubygems.org" gemspec gem "redcarpet", :platforms => :ruby diff --git a/Gemfile.lock b/Gemfile.lock index 30c4454c..b6d184d4 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -12,7 +12,7 @@ PATH github-markup (5.0.1) GEM - remote: http://rubygems.org/ + remote: https://rubygems.org/ specs: RedCloth (4.3.4) activesupport (7.1.3.4) From 1e2c03935912e5cf4bfb81726f5a9bfe18a86c43 Mon Sep 17 00:00:00 2001 From: jmeridth Date: Tue, 6 Aug 2024 15:24:51 -0500 Subject: [PATCH 21/34] fix: add explicit permissions to ci github action Fixing a code scanning alert Signed-off-by: jmeridth --- .github/workflows/ci.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index e0feed3c..9e8e31dc 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -4,6 +4,9 @@ on: [push, pull_request] env: JRUBY_OPTS: -Xcext.enabled=true +permissions: + contents: read + jobs: build: name: "Test / Ruby ${{ matrix.ruby }}" From 6d287a98bb5a400b780bc9db191899ba442dd6ec Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Thu, 22 Aug 2024 20:51:15 +0000 Subject: [PATCH 22/34] chore(deps): bump rexml from 3.3.3 to 3.3.6 in the bundler group Bumps the bundler group with 1 update: [rexml](https://github.com/ruby/rexml). Updates `rexml` from 3.3.3 to 3.3.6 - [Release notes](https://github.com/ruby/rexml/releases) - [Changelog](https://github.com/ruby/rexml/blob/master/NEWS.md) - [Commits](https://github.com/ruby/rexml/compare/v3.3.3...v3.3.6) --- updated-dependencies: - dependency-name: rexml dependency-type: direct:production dependency-group: bundler ... Signed-off-by: dependabot[bot] --- Gemfile.lock | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Gemfile.lock b/Gemfile.lock index 6dc75c96..d2c84309 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -75,7 +75,7 @@ GEM rdoc (6.7.0) psych (>= 4.0.0) redcarpet (3.6.0) - rexml (3.3.3) + rexml (3.3.6) strscan ruby-enum (0.9.0) i18n From 2880c2c6d108531a8eed179b369762e0aeaec9ce Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 2 Sep 2024 11:01:09 +0000 Subject: [PATCH 23/34] chore(deps): bump the dependencies group across 1 directory with 2 updates Bumps the dependencies group with 2 updates in the / directory: [ruby/setup-ruby](https://github.com/ruby/setup-ruby) and [actions/setup-python](https://github.com/actions/setup-python). Updates `ruby/setup-ruby` from 1.180.0 to 1.190.0 - [Release notes](https://github.com/ruby/setup-ruby/releases) - [Changelog](https://github.com/ruby/setup-ruby/blob/master/release.rb) - [Commits](https://github.com/ruby/setup-ruby/compare/ff740bc00a01b3a50fffc55a1071b1060eeae9dc...a6e6f86333f0a2523ece813039b8b4be04560854) Updates `actions/setup-python` from 5.1.0 to 5.2.0 - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](https://github.com/actions/setup-python/compare/82c7e631bb3cdc910f68e0081d67478d79c6982d...f677139bbe7f9c59b41e40162b753c062f5d49a3) --- updated-dependencies: - dependency-name: ruby/setup-ruby dependency-type: direct:production update-type: version-update:semver-minor dependency-group: dependencies - dependency-name: actions/setup-python dependency-type: direct:production update-type: version-update:semver-minor dependency-group: dependencies ... Signed-off-by: dependabot[bot] --- .github/workflows/ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 9e8e31dc..3640b8b4 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -26,12 +26,12 @@ jobs: with: fetch-depth: 10 - - uses: ruby/setup-ruby@ff740bc00a01b3a50fffc55a1071b1060eeae9dc # v1 + - uses: ruby/setup-ruby@a6e6f86333f0a2523ece813039b8b4be04560854 # v1 with: ruby-version: ${{ matrix.ruby }} bundler-cache: true - - uses: actions/setup-python@82c7e631bb3cdc910f68e0081d67478d79c6982d # v5 + - uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5 with: # This should match lib/github/markups.rb GitHub::Markups::MARKUP_RST python-version: '3.x' From b4f9c54a4b4c117cb315cd0f4df09ffd5a1484b7 Mon Sep 17 00:00:00 2001 From: jmeridth Date: Wed, 4 Sep 2024 15:06:15 -0500 Subject: [PATCH 24/34] chore: add .venv/venv to .gitignore best practices with local python development is to create a virtual environment. The most common are either .venv or venv folders in the root of the repo. We currently install [docutils](https://github.com/github/markup/blob/914839fd31c93b93a8054a3c91fce0906b2d1375/script/bootstrap#L8) via pip (python). - [x] add .venv/venv folders to .gitignore - [x] update README with how to setup locally environment Signed-off-by: jmeridth --- .gitignore | 2 ++ README.md | 9 +++++++++ 2 files changed, 11 insertions(+) diff --git a/.gitignore b/.gitignore index eac4d715..b0f0821c 100644 --- a/.gitignore +++ b/.gitignore @@ -6,3 +6,5 @@ pkg/ *~ vendor/ .DS_Store +.venv +venv diff --git a/README.md b/README.md index b2bcc809..3aeb7110 100644 --- a/README.md +++ b/README.md @@ -72,6 +72,15 @@ require 'github/markup' GitHub::Markup.render_s(GitHub::Markups::MARKUP_MARKDOWN, "* One\n* Two") ``` +Local Development +----------------- + +```sh +python3 -m venv .venv +source .venv/bin/activate +cd script +./bootstrap +``` Contributing ------------ From bc6e6e36a6cdf5e4cd73f4d3bcfafd05c3e4cb67 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 9 Sep 2024 10:25:23 +0000 Subject: [PATCH 25/34] chore(deps): bump ruby/setup-ruby in the dependencies group Bumps the dependencies group with 1 update: [ruby/setup-ruby](https://github.com/ruby/setup-ruby). Updates `ruby/setup-ruby` from 1.190.0 to 1.191.0 - [Release notes](https://github.com/ruby/setup-ruby/releases) - [Changelog](https://github.com/ruby/setup-ruby/blob/master/release.rb) - [Commits](https://github.com/ruby/setup-ruby/compare/a6e6f86333f0a2523ece813039b8b4be04560854...52753b7da854d5c07df37391a986c76ab4615999) --- updated-dependencies: - dependency-name: ruby/setup-ruby dependency-type: direct:production update-type: version-update:semver-minor dependency-group: dependencies ... Signed-off-by: dependabot[bot] --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 3640b8b4..dd8812d5 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -26,7 +26,7 @@ jobs: with: fetch-depth: 10 - - uses: ruby/setup-ruby@a6e6f86333f0a2523ece813039b8b4be04560854 # v1 + - uses: ruby/setup-ruby@52753b7da854d5c07df37391a986c76ab4615999 # v1 with: ruby-version: ${{ matrix.ruby }} bundler-cache: true From 459fb1b32f42e005140979f007ad84ca75e0b7d2 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 23 Sep 2024 10:32:15 +0000 Subject: [PATCH 26/34] chore(deps): bump ruby/setup-ruby in the dependencies group Bumps the dependencies group with 1 update: [ruby/setup-ruby](https://github.com/ruby/setup-ruby). Updates `ruby/setup-ruby` from 1.191.0 to 1.193.0 - [Release notes](https://github.com/ruby/setup-ruby/releases) - [Changelog](https://github.com/ruby/setup-ruby/blob/master/release.rb) - [Commits](https://github.com/ruby/setup-ruby/compare/52753b7da854d5c07df37391a986c76ab4615999...f321cf5a4d1533575411f8752cf25b86478b0442) --- updated-dependencies: - dependency-name: ruby/setup-ruby dependency-type: direct:production update-type: version-update:semver-minor dependency-group: dependencies ... Signed-off-by: dependabot[bot] --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index dd8812d5..3ed2585a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -26,7 +26,7 @@ jobs: with: fetch-depth: 10 - - uses: ruby/setup-ruby@52753b7da854d5c07df37391a986c76ab4615999 # v1 + - uses: ruby/setup-ruby@f321cf5a4d1533575411f8752cf25b86478b0442 # v1 with: ruby-version: ${{ matrix.ruby }} bundler-cache: true From af6b5419e67273b90a3db2cdfaeab46f40c2d80c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 30 Sep 2024 10:32:39 +0000 Subject: [PATCH 27/34] chore(deps): bump the dependencies group with 2 updates Bumps the dependencies group with 2 updates: [actions/checkout](https://github.com/actions/checkout) and [ruby/setup-ruby](https://github.com/ruby/setup-ruby). Updates `actions/checkout` from 4.1.7 to 4.2.0 - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/692973e3d937129bcbf40652eb9f2f61becf3332...d632683dd7b4114ad314bca15554477dd762a938) Updates `ruby/setup-ruby` from 1.193.0 to 1.194.0 - [Release notes](https://github.com/ruby/setup-ruby/releases) - [Changelog](https://github.com/ruby/setup-ruby/blob/master/release.rb) - [Commits](https://github.com/ruby/setup-ruby/compare/f321cf5a4d1533575411f8752cf25b86478b0442...c04af2bb7258bb6a03df1d3c1865998ac9390972) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-minor dependency-group: dependencies - dependency-name: ruby/setup-ruby dependency-type: direct:production update-type: version-update:semver-minor dependency-group: dependencies ... Signed-off-by: dependabot[bot] --- .github/workflows/ci.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 3ed2585a..effc3f2a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -22,11 +22,11 @@ jobs: steps: - name: Checkout - uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4 + uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4 with: fetch-depth: 10 - - uses: ruby/setup-ruby@f321cf5a4d1533575411f8752cf25b86478b0442 # v1 + - uses: ruby/setup-ruby@c04af2bb7258bb6a03df1d3c1865998ac9390972 # v1 with: ruby-version: ${{ matrix.ruby }} bundler-cache: true From 0a930b28d65d8d3bffec77ee3dbaafcb11032d32 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 28 Oct 2024 18:49:07 +0000 Subject: [PATCH 28/34] chore(deps): bump rexml from 3.3.6 to 3.3.9 in the bundler group Bumps the bundler group with 1 update: [rexml](https://github.com/ruby/rexml). Updates `rexml` from 3.3.6 to 3.3.9 - [Release notes](https://github.com/ruby/rexml/releases) - [Changelog](https://github.com/ruby/rexml/blob/master/NEWS.md) - [Commits](https://github.com/ruby/rexml/compare/v3.3.6...v3.3.9) --- updated-dependencies: - dependency-name: rexml dependency-type: direct:production dependency-group: bundler ... Signed-off-by: dependabot[bot] --- Gemfile.lock | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/Gemfile.lock b/Gemfile.lock index d2c84309..761f6cc0 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -75,8 +75,7 @@ GEM rdoc (6.7.0) psych (>= 4.0.0) redcarpet (3.6.0) - rexml (3.3.6) - strscan + rexml (3.3.9) ruby-enum (0.9.0) i18n rubypants (0.7.1) @@ -85,7 +84,6 @@ GEM crass (~> 1.0.2) nokogiri (>= 1.12.0) stringio (3.1.1) - strscan (3.1.0) tdiff (0.4.0) twitter-text (1.14.7) unf (~> 0.1.0) From 57e250f0fb775a154a0184702f310f954b3d5762 Mon Sep 17 00:00:00 2001 From: jmeridth Date: Sun, 3 Nov 2024 22:34:28 -0600 Subject: [PATCH 29/34] fix: stale issue/pr message Signed-off-by: jmeridth --- .github/workflows/stale.yml | 26 ++++++++++++-------------- 1 file changed, 12 insertions(+), 14 deletions(-) diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index 6f52b5d0..fc5a93dc 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -1,27 +1,25 @@ -# This workflow warns and then closes issues and PRs that have had no activity for a specified amount of time. -# -# You can adjust the behavior by modifying this file. -# For more information, see: -# https://github.com/actions/stale name: Mark stale issues and pull requests on: schedule: - - cron: '0 12 * * *' + - cron: "0 12 * * *" jobs: stale: - runs-on: ubuntu-latest permissions: issues: write pull-requests: write steps: - - uses: actions/stale@f7176fd3007623b69d27091f9b9d4ab7995f0a06 # v5 - with: - repo-token: ${{ secrets.GITHUB_TOKEN }} - stale-issue-message: 'Stale issue message' - stale-pr-message: 'Stale pull request message' - stale-issue-label: 'no-issue-activity' - stale-pr-label: 'no-pr-activity' + - uses: actions/stale@f7176fd3007623b69d27091f9b9d4ab7995f0a06 # v5 + with: + repo-token: ${{ secrets.GITHUB_TOKEN }} + stale-issue-message: > + This issue has been automatically marked as stale because it has not + had recent activity. It will be closed if no further activity occurs. + Thank you for your contributions. + stale-pr-message: > + This pull request has been automatically marked as stale because it has not + had recent activity. It will be closed if no further activity occurs. + Thank you for your contributions. From 371da086ed849e8a3b255eed932b040ef7ca2042 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 4 Nov 2024 10:49:14 +0000 Subject: [PATCH 30/34] chore(deps): bump the dependencies group across 1 directory with 4 updates Bumps the dependencies group with 4 updates in the / directory: [actions/checkout](https://github.com/actions/checkout), [ruby/setup-ruby](https://github.com/ruby/setup-ruby), [actions/setup-python](https://github.com/actions/setup-python) and [actions/cache](https://github.com/actions/cache). Updates `actions/checkout` from 4.2.0 to 4.2.2 - [Release notes](https://github.com/actions/checkout/releases) - [Changelog](https://github.com/actions/checkout/blob/main/CHANGELOG.md) - [Commits](https://github.com/actions/checkout/compare/d632683dd7b4114ad314bca15554477dd762a938...11bd71901bbe5b1630ceea73d27597364c9af683) Updates `ruby/setup-ruby` from 1.194.0 to 1.199.0 - [Release notes](https://github.com/ruby/setup-ruby/releases) - [Changelog](https://github.com/ruby/setup-ruby/blob/master/release.rb) - [Commits](https://github.com/ruby/setup-ruby/compare/c04af2bb7258bb6a03df1d3c1865998ac9390972...7d3497fd78c07c0d84ebafa58d8dac60cd1f0763) Updates `actions/setup-python` from 5.2.0 to 5.3.0 - [Release notes](https://github.com/actions/setup-python/releases) - [Commits](https://github.com/actions/setup-python/compare/f677139bbe7f9c59b41e40162b753c062f5d49a3...0b93645e9fea7318ecaed2b359559ac225c90a2b) Updates `actions/cache` from 4.0.2 to 4.1.2 - [Release notes](https://github.com/actions/cache/releases) - [Changelog](https://github.com/actions/cache/blob/main/RELEASES.md) - [Commits](https://github.com/actions/cache/compare/0c45773b623bea8c8e75f6c82b208c3cf94ea4f9...6849a6489940f00c2f30c0fb92c6274307ccb58a) --- updated-dependencies: - dependency-name: actions/checkout dependency-type: direct:production update-type: version-update:semver-patch dependency-group: dependencies - dependency-name: ruby/setup-ruby dependency-type: direct:production update-type: version-update:semver-minor dependency-group: dependencies - dependency-name: actions/setup-python dependency-type: direct:production update-type: version-update:semver-minor dependency-group: dependencies - dependency-name: actions/cache dependency-type: direct:production update-type: version-update:semver-minor dependency-group: dependencies ... Signed-off-by: dependabot[bot] --- .github/workflows/ci.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index effc3f2a..0a661e9b 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -22,21 +22,21 @@ jobs: steps: - name: Checkout - uses: actions/checkout@d632683dd7b4114ad314bca15554477dd762a938 # v4 + uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 with: fetch-depth: 10 - - uses: ruby/setup-ruby@c04af2bb7258bb6a03df1d3c1865998ac9390972 # v1 + - uses: ruby/setup-ruby@7d3497fd78c07c0d84ebafa58d8dac60cd1f0763 # v1 with: ruby-version: ${{ matrix.ruby }} bundler-cache: true - - uses: actions/setup-python@f677139bbe7f9c59b41e40162b753c062f5d49a3 # v5 + - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5 with: # This should match lib/github/markups.rb GitHub::Markups::MARKUP_RST python-version: '3.x' - - uses: actions/cache@0c45773b623bea8c8e75f6c82b208c3cf94ea4f9 # v4 + - uses: actions/cache@6849a6489940f00c2f30c0fb92c6274307ccb58a # v4 with: path: ~/.cache/pip key: ${{ runner.os }}-pip From 5767386b134d0b70634a2187001beadafaf39a3c Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 4 Nov 2024 10:49:47 +0000 Subject: [PATCH 31/34] chore(deps): bump the dependencies group across 1 directory with 6 updates Updates the requirements on [org-ruby](https://github.com/wallyqs/org-ruby), [creole](https://github.com/minad/creole), [activesupport](https://github.com/rails/rails), [minitest](https://github.com/minitest/minitest), [sanitize](https://github.com/rgrove/sanitize) and [nokogiri](https://github.com/sparklemotion/nokogiri) to permit the latest version. Updates `org-ruby` from 0.9.9 to 0.9.12 - [Changelog](https://github.com/wallyqs/org-ruby/blob/master/History.org) - [Commits](https://github.com/wallyqs/org-ruby/compare/version-0.9.9...version-0.9.12) Updates `creole` from 0.3.8 to 0.5.0 - [Changelog](https://github.com/minad/creole/blob/master/CHANGES) - [Commits](https://github.com/minad/creole/compare/0.3.8...v0.5.0) Updates `activesupport` from 7.1.3.4 to 7.1.5 - [Release notes](https://github.com/rails/rails/releases) - [Changelog](https://github.com/rails/rails/blob/v7.2.2/activesupport/CHANGELOG.md) - [Commits](https://github.com/rails/rails/compare/v7.1.3.4...v7.1.5) Updates `minitest` from 5.23.1 to 5.25.1 - [Changelog](https://github.com/minitest/minitest/blob/master/History.rdoc) - [Commits](https://github.com/minitest/minitest/compare/v5.23.1...v5.25.1) Updates `sanitize` from 6.1.1 to 6.1.3 - [Release notes](https://github.com/rgrove/sanitize/releases) - [Changelog](https://github.com/rgrove/sanitize/blob/main/HISTORY.md) - [Commits](https://github.com/rgrove/sanitize/compare/v6.1.1...v6.1.3) Updates `nokogiri` from 1.16.6 to 1.16.7 - [Release notes](https://github.com/sparklemotion/nokogiri/releases) - [Changelog](https://github.com/sparklemotion/nokogiri/blob/main/CHANGELOG.md) - [Commits](https://github.com/sparklemotion/nokogiri/compare/v1.16.6...v1.16.7) --- updated-dependencies: - dependency-name: org-ruby dependency-type: direct:production update-type: version-update:semver-patch dependency-group: dependencies - dependency-name: creole dependency-type: direct:production update-type: version-update:semver-minor dependency-group: dependencies - dependency-name: activesupport dependency-type: direct:development update-type: version-update:semver-patch dependency-group: dependencies - dependency-name: minitest dependency-type: direct:development update-type: version-update:semver-minor dependency-group: dependencies - dependency-name: sanitize dependency-type: direct:development update-type: version-update:semver-patch dependency-group: dependencies - dependency-name: nokogiri dependency-type: direct:development update-type: version-update:semver-patch dependency-group: dependencies ... Signed-off-by: dependabot[bot] --- Gemfile | 4 ++-- Gemfile.lock | 40 +++++++++++++++++++++++----------------- github-markup.gemspec | 2 +- 3 files changed, 26 insertions(+), 20 deletions(-) diff --git a/Gemfile b/Gemfile index 9b317555..b2983b9b 100644 --- a/Gemfile +++ b/Gemfile @@ -8,8 +8,8 @@ gem "RedCloth" # however we want to bump up to this version since this has a security patch gem "commonmarker", git: "https://github.com/gjtorikian/commonmarker.git", tag: "v0.18.3" gem "rdoc", "~> 6.7.0" -gem "org-ruby", "= 0.9.9" -gem "creole", "~>0.3.6" +gem "org-ruby", "0.9.12" +gem "creole", "~>0.5.0" gem "wikicloth", "=0.8.3" gem "twitter-text", "~> 1.14" gem "asciidoctor", "~> 2.0.5" diff --git a/Gemfile.lock b/Gemfile.lock index 761f6cc0..5912d3b1 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -15,26 +15,30 @@ GEM remote: https://rubygems.org/ specs: RedCloth (4.3.4) - activesupport (7.1.3.4) + activesupport (7.1.5) base64 + benchmark (>= 0.3) bigdecimal concurrent-ruby (~> 1.0, >= 1.0.2) connection_pool (>= 2.2.5) drb i18n (>= 1.6, < 2) + logger (>= 1.4.2) minitest (>= 5.1) mutex_m + securerandom (>= 0.3) tzinfo (~> 2.0) asciidoctor (2.0.23) base64 (0.2.0) + benchmark (0.3.0) bigdecimal (3.1.8) builder (3.3.0) cgi (0.4.1) charlock_holmes (0.7.7) - concurrent-ruby (1.3.3) + concurrent-ruby (1.3.4) connection_pool (2.4.1) crass (1.0.6) - creole (0.3.8) + creole (0.5.0) drb (2.2.1) expression_parser (0.9.0) github-linguist (7.30.0) @@ -46,31 +50,32 @@ GEM activesupport (>= 2) nokogiri (~> 1.4) htmlentities (4.3.4) - i18n (1.14.5) + i18n (1.14.6) concurrent-ruby (~> 1.0) + logger (1.6.1) mini_mime (1.1.5) - minitest (5.23.1) + minitest (5.25.1) mutex_m (0.2.0) - nokogiri (1.16.6-aarch64-linux) + nokogiri (1.16.7-aarch64-linux) racc (~> 1.4) - nokogiri (1.16.6-arm-linux) + nokogiri (1.16.7-arm-linux) racc (~> 1.4) - nokogiri (1.16.6-arm64-darwin) + nokogiri (1.16.7-arm64-darwin) racc (~> 1.4) - nokogiri (1.16.6-x86-linux) + nokogiri (1.16.7-x86-linux) racc (~> 1.4) - nokogiri (1.16.6-x86_64-darwin) + nokogiri (1.16.7-x86_64-darwin) racc (~> 1.4) - nokogiri (1.16.6-x86_64-linux) + nokogiri (1.16.7-x86_64-linux) racc (~> 1.4) nokogiri-diff (0.3.0) nokogiri (~> 1.5) tdiff (~> 0.4) - org-ruby (0.9.9) + org-ruby (0.9.12) rubypants (~> 0.2) psych (5.1.2) stringio - racc (1.8.0) + racc (1.8.1) rake (13.2.1) rdoc (6.7.0) psych (>= 4.0.0) @@ -80,9 +85,10 @@ GEM i18n rubypants (0.7.1) rugged (1.7.2) - sanitize (6.1.1) + sanitize (6.1.3) crass (~> 1.0.2) nokogiri (>= 1.12.0) + securerandom (0.3.1) stringio (3.1.1) tdiff (0.4.0) twitter-text (1.14.7) @@ -109,10 +115,10 @@ PLATFORMS DEPENDENCIES RedCloth - activesupport (~> 7.1.3.4) + activesupport (~> 7.1.5) asciidoctor (~> 2.0.5) commonmarker! - creole (~> 0.3.6) + creole (~> 0.5.0) github-linguist (>= 7.1.3) github-markup! html-pipeline (~> 1.0) @@ -120,7 +126,7 @@ DEPENDENCIES minitest (~> 5.4, >= 5.4.3) nokogiri (~> 1.16.5) nokogiri-diff (~> 0.3.0) - org-ruby (= 0.9.9) + org-ruby (= 0.9.12) rake rdoc (~> 6.7.0) redcarpet diff --git a/github-markup.gemspec b/github-markup.gemspec index 260df18c..ccf5908a 100644 --- a/github-markup.gemspec +++ b/github-markup.gemspec @@ -21,7 +21,7 @@ Gem::Specification.new do |s| s.require_paths = %w[lib] s.add_development_dependency 'rake', '~> 12' - s.add_development_dependency 'activesupport', '~> 7.1.3.4' + s.add_development_dependency 'activesupport', '~> 7.1.5' s.add_development_dependency 'minitest', '~> 5.4', '>= 5.4.3' s.add_development_dependency 'html-pipeline', '~> 1.0' s.add_development_dependency 'sanitize', '>= 4.6.3' From cec16df50930cfd7870f6addab2e0acdaedb41f1 Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 11 Nov 2024 10:28:29 +0000 Subject: [PATCH 32/34] chore(deps): bump ruby/setup-ruby in the dependencies group Bumps the dependencies group with 1 update: [ruby/setup-ruby](https://github.com/ruby/setup-ruby). Updates `ruby/setup-ruby` from 1.199.0 to 1.202.0 - [Release notes](https://github.com/ruby/setup-ruby/releases) - [Changelog](https://github.com/ruby/setup-ruby/blob/master/release.rb) - [Commits](https://github.com/ruby/setup-ruby/compare/7d3497fd78c07c0d84ebafa58d8dac60cd1f0763...a2bbe5b1b236842c1cb7dd11e8e3b51e0a616acc) --- updated-dependencies: - dependency-name: ruby/setup-ruby dependency-type: direct:production update-type: version-update:semver-minor dependency-group: dependencies ... Signed-off-by: dependabot[bot] --- .github/workflows/ci.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 0a661e9b..b2c0469c 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -26,7 +26,7 @@ jobs: with: fetch-depth: 10 - - uses: ruby/setup-ruby@7d3497fd78c07c0d84ebafa58d8dac60cd1f0763 # v1 + - uses: ruby/setup-ruby@a2bbe5b1b236842c1cb7dd11e8e3b51e0a616acc # v1 with: ruby-version: ${{ matrix.ruby }} bundler-cache: true From eed8f53691db84d1788fd142c9235bb6b8379b76 Mon Sep 17 00:00:00 2001 From: jmeridth Date: Mon, 18 Nov 2024 09:10:32 -0600 Subject: [PATCH 33/34] chore: add keep label to mark issues/prs from being marked as stale - [x] added keep label to repo - [x] add `exempt-issue-labels` and `exempt-pre-labels` to stale config Signed-off-by: jmeridth --- .github/workflows/stale.yml | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index fc5a93dc..ef40f1b0 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -23,3 +23,5 @@ jobs: This pull request has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions. + exempt-issue-labels: keep + exempt-pr-labels: keep From 9362a5204fd1551e692b5d9c7a44b70b9e5d4374 Mon Sep 17 00:00:00 2001 From: jmeridth Date: Mon, 18 Nov 2024 09:31:19 -0600 Subject: [PATCH 34/34] fix: switch from shas to tags for immutable actions closes 4 security warnings Signed-off-by: jmeridth --- .github/workflows/ci.yml | 8 ++++---- .github/workflows/stale.yml | 2 +- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index b2c0469c..0eb7e108 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -22,7 +22,7 @@ jobs: steps: - name: Checkout - uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4 + uses: actions/checkout@v4.2.2 with: fetch-depth: 10 @@ -31,12 +31,12 @@ jobs: ruby-version: ${{ matrix.ruby }} bundler-cache: true - - uses: actions/setup-python@0b93645e9fea7318ecaed2b359559ac225c90a2b # v5 + - uses: actions/setup-python@v5.3.0 with: # This should match lib/github/markups.rb GitHub::Markups::MARKUP_RST - python-version: '3.x' + python-version: "3.x" - - uses: actions/cache@6849a6489940f00c2f30c0fb92c6274307ccb58a # v4 + - uses: actions/cache@v4.1.2 with: path: ~/.cache/pip key: ${{ runner.os }}-pip diff --git a/.github/workflows/stale.yml b/.github/workflows/stale.yml index ef40f1b0..2ef91e16 100644 --- a/.github/workflows/stale.yml +++ b/.github/workflows/stale.yml @@ -12,7 +12,7 @@ jobs: pull-requests: write steps: - - uses: actions/stale@f7176fd3007623b69d27091f9b9d4ab7995f0a06 # v5 + - uses: actions/stale@v9.0.0 with: repo-token: ${{ secrets.GITHUB_TOKEN }} stale-issue-message: >