🧪 add regression test for available octicons (#187)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>

Author: chrisjsewell

tests/test_misc.py

@@ -0,0 +1,15 @@
+from sphinx_design.icons import get_octicon_data
+
+
+def test_octicons(file_regression):
+    """Test the available octicon names.
+
+    This is intended to provide a diff of the octicons available,
+    when the octicons are updated, to check if we are removing any
+    (and hence breaking back-compatibility).
+    """
+    data = get_octicon_data()
+    content = ""
+    for octicon in sorted(get_octicon_data()):
+        content += f"{octicon}: {','.join(data[octicon]['heights'])}\n"
+    file_regression.check(content)

tests/test_misc/test_octicons.txt

@@ -0,0 +1,248 @@
+alert: 16,24
+alert-fill: 12
+archive: 16,24
+arrow-both: 16,24
+arrow-down: 16,24
+arrow-down-left: 24
+arrow-down-right: 24
+arrow-left: 16,24
+arrow-right: 16,24
+arrow-switch: 16,24
+arrow-up: 16,24
+arrow-up-left: 24
+arrow-up-right: 24
+beaker: 16,24
+bell: 16,24
+bell-fill: 16,24
+bell-slash: 16,24
+blocked: 16,24
+bold: 16,24
+book: 16,24
+bookmark: 16,24
+bookmark-fill: 24
+bookmark-slash: 16,24
+bookmark-slash-fill: 24
+briefcase: 16,24
+broadcast: 16,24
+browser: 16,24
+bug: 16,24
+calendar: 16,24
+check: 16,24
+check-circle: 16,24
+check-circle-fill: 12,16,24
+checklist: 16,24
+chevron-down: 16,24
+chevron-left: 16,24
+chevron-right: 16,24
+chevron-up: 16,24
+circle: 16,24
+circle-slash: 16,24
+clock: 16,24
+code: 16,24
+code-review: 16,24
+code-square: 16,24
+codescan: 16,24
+codescan-checkmark: 16,24
+codespaces: 16,24
+columns: 16,24
+comment: 16,24
+comment-discussion: 16,24
+commit: 24
+container: 16,24
+copy: 16,24
+cpu: 16,24
+credit-card: 16,24
+cross-reference: 16,24
+dash: 16,24
+database: 16,24
+dependabot: 16,24
+desktop-download: 16,24
+device-camera: 16
+device-camera-video: 16,24
+device-desktop: 16,24
+device-mobile: 16,24
+diamond: 16,24
+diff: 16,24
+diff-added: 16
+diff-ignored: 16
+diff-modified: 16
+diff-removed: 16
+diff-renamed: 16
+dot: 16,24
+dot-fill: 16,24
+download: 16,24
+duplicate: 16,24
+ellipsis: 16
+eye: 16,24
+eye-closed: 16,24
+file: 16,24
+file-badge: 16
+file-binary: 16,24
+file-code: 16,24
+file-diff: 16,24
+file-directory: 16,24
+file-directory-fill: 24
+file-media: 24
+file-submodule: 16,24
+file-symlink-file: 16,24
+file-zip: 16,24
+filter: 16,24
+flame: 16,24
+fold: 16,24
+fold-down: 16,24
+fold-up: 16,24
+gear: 16,24
+gift: 16,24
+git-branch: 16,24
+git-commit: 16,24
+git-compare: 16,24
+git-merge: 16,24
+git-pull-request: 16,24
+git-pull-request-closed: 16,24
+git-pull-request-draft: 16,24
+globe: 16,24
+grabber: 16,24
+graph: 16,24
+hash: 16,24
+heading: 16,24
+heart: 16,24
+heart-fill: 16,24
+history: 16,24
+home: 16,24
+home-fill: 24
+horizontal-rule: 16,24
+hourglass: 16,24
+hubot: 16,24
+image: 16,24
+inbox: 16,24
+infinity: 16,24
+info: 16,24
+issue-closed: 16,24
+issue-draft: 16,24
+issue-opened: 16,24
+issue-reopened: 16,24
+italic: 16,24
+iterations: 16,24
+kebab-horizontal: 16,24
+key: 16,24
+key-asterisk: 16
+law: 16,24
+light-bulb: 16,24
+link: 16,24
+link-external: 16,24
+list-ordered: 16,24
+list-unordered: 16,24
+location: 16,24
+lock: 16,24
+logo-gist: 16
+logo-github: 16
+mail: 16,24
+mark-github: 16
+markdown: 16
+megaphone: 16,24
+mention: 16,24
+meter: 16
+milestone: 16,24
+mirror: 16,24
+moon: 16,24
+mortar-board: 16,24
+multi-select: 16,24
+mute: 16,24
+no-entry: 16,24
+no-entry-fill: 12
+north-star: 16,24
+note: 16,24
+number: 16,24
+organization: 16,24
+package: 16,24
+package-dependencies: 16,24
+package-dependents: 16,24
+paintbrush: 16
+paper-airplane: 16,24
+paste: 16,24
+pencil: 16,24
+people: 16,24
+person: 16,24
+person-add: 16,24
+person-fill: 16,24
+pin: 16,24
+play: 16,24
+plug: 16,24
+plus: 16,24
+plus-circle: 16,24
+project: 16,24
+pulse: 16,24
+question: 16,24
+quote: 16,24
+reply: 16,24
+repo: 16,24
+repo-clone: 16
+repo-forked: 16,24
+repo-pull: 16
+repo-push: 16,24
+repo-template: 16,24
+report: 16,24
+rocket: 16,24
+rows: 16,24
+rss: 16,24
+ruby: 16,24
+screen-full: 16,24
+screen-normal: 16,24
+search: 16,24
+server: 16,24
+share: 16,24
+share-android: 16,24
+shield: 16,24
+shield-check: 16,24
+shield-lock: 16,24
+shield-x: 16,24
+sidebar-collapse: 16,24
+sidebar-expand: 16,24
+sign-in: 16,24
+sign-out: 16,24
+single-select: 16,24
+skip: 16,24
+smiley: 16,24
+sort-asc: 16,24
+sort-desc: 16,24
+square: 16,24
+square-fill: 16,24
+squirrel: 16,24
+stack: 16,24
+star: 16,24
+star-fill: 16,24
+stop: 16,24
+stopwatch: 16,24
+strikethrough: 16,24
+sun: 16,24
+sync: 16,24
+tab: 24
+table: 16,24
+tag: 16,24
+tasklist: 16,24
+telescope: 16,24
+telescope-fill: 16,24
+terminal: 16,24
+three-bars: 16
+thumbsdown: 16,24
+thumbsup: 16,24
+tools: 16,24
+trash: 16,24
+triangle-down: 16,24
+triangle-left: 16,24
+triangle-right: 16,24
+triangle-up: 16,24
+typography: 16,24
+unfold: 16,24
+unlock: 16,24
+unmute: 16,24
+unverified: 16,24
+upload: 16,24
+verified: 16,24
+versions: 16,24
+video: 16,24
+workflow: 16,24
+x: 16,24
+x-circle: 16,24
+x-circle-fill: 12,16,24
+zap: 16,24